Timer:LeftTillSimTimeLimitS

From Data Realms Wiki

---

Revision as of 00:46, 28 June 2012

Function
Syntax	LeftTillSimTimeLimitS( * None. )
Description:
Returns how much time in ms that there is left till this Timer reaches a certain time limit previously set by SetSimTimeLimitS.
Returns	A unsigned long with the sim time left till the passed in value, or negative if this Timer is already past that point in time.

Example
Description	This will gib the object this script is attached to after 5 seconds have passed.
Code	function create(self)     self.LTimer = Timer(); --this is needed for "Timer:IsPastSimMS" to work. end   function update(self)     if Timer:IsPastSimMs(5000) == true then --checks if 5 seconds (5000 milliseconds) have passed         self:GibThis(); --if 5 seconds have passed, gib(kill) the object!     end end
Output	nil