Timer:IsPastSimMS

(Difference between revisions)

Revision as of 00:23, 28 June 2012

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

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

@@ Line 1: / Line 1: @@
 {{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)
      self.LTimer = Timer(); --this is needed for "Timer:IsPastSimMS" to work.
@@ Line 16: / Line 15: @@
      end
 end</code>
-|output		= nil
+|output               = nil
-}}
+|}}