Timer:LeftTillSimTimeLimitMS

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
m (updating function page)
m (updating function page)
 
Line 5: Line 5:
|description =
|description =
Returns how much time in ms that there is left till this Timer reaches a certain time limit previously set by SetSimTimeLimitMS.
Returns how much time in ms that there is left till this Timer reaches a certain time limit previously set by SetSimTimeLimitMS.
-
|codedesc = This will gib the object this script is attached to after 5 seconds have passed.
+
  }}
-
|code = <code lua n>
+
-
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</code>
+
-
|output = nil
+
-
}}
+

Latest revision as of 00:56, 28 June 2012

Function
SyntaxLeftTillSimTimeLimitMS( * None. )
Description:
Returns how much time in ms that there is left till this Timer reaches a certain time limit previously set by SetSimTimeLimitMS.
ReturnsA 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
DescriptionPlaceholder!
Code
  1. for k,v in pairs(PagesWithoutExamples) do
  2.     v.MakeExample(NoErrors);
  3. end
OutputPlaceholder!
Personal tools