Timer:IsPastSimMS

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
m (updating function page)
m (Reverted edits by Beautifybot (talk) to last revision by DrLuke)
Line 1: Line 1:
{{LuaFunction
{{LuaFunction
-
|function_name =IsPastSimMS
+
|function_name       = Timer:IsPastSimMS
-
|arguments =* A unsigned long specifying the threshold amount of time in ms.
+
|arguments           = [[number]] Time in milliseconds
-
|returns =A bool only yielding true if the elapsed time is greater than the passed in value.
+
|returns             = [[nil]]
-
|description =
+
|description         = This function will check, whether a certain time has passed after the timer has been created.
-
Returns true if the elapsed time is past a certain amount of time.
+
|codedesc             = This will gib the object this script is attached to after 5 seconds have passed.
-
|codedesc = This will gib the object this script is attached to after 5 seconds have passed.
+
|code                 = <code lua n>
-
|code = <code lua n>
+
function create(self)
function create(self)
     self.LTimer = Timer(); --this is needed for "Timer:IsPastSimMS" to work.
     self.LTimer = Timer(); --this is needed for "Timer:IsPastSimMS" to work.
Line 16: Line 15:
     end
     end
end</code>
end</code>
-
|output = nil
+
|output               = nil
-
}}
+
|}}

Revision as of 00:23, 28 June 2012

Function
SyntaxTimer:IsPastSimMS( number Time in milliseconds )
Description:
This function will check, whether a certain time has passed after the timer has been created.
Returnsnil




Example
DescriptionThis will gib the object this script is attached to after 5 seconds have passed.
Code
  1. function create(self)
  2.     self.LTimer = Timer(); --this is needed for "Timer:IsPastSimMS" to work.
  3. end
  4.  
  5. function update(self)
  6.     if Timer:IsPastSimMs(5000) == true then --checks if 5 seconds (5000 milliseconds) have passed
  7.         self:GibThis(); --if 5 seconds have passed, gib(kill) the object!
  8.     end
  9. end
Outputnil
Personal tools