Timer:IsPastSimMS

(Difference between revisions)

Revision as of 00:46, 28 June 2012

Function
Syntax	IsPastSimMS( * A unsigned long specifying the threshold amount of time in ms. )
Description:
Returns true if the elapsed time is past a certain amount of time.
Returns	A bool only yielding true if the elapsed time is greater than the passed in value.

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        = Timer:IsPastSimMS
+|function_name		=IsPastSimMS
-|arguments            = [[number]] Time in milliseconds
+|arguments		=* A unsigned long specifying the threshold amount of time in ms.
-|returns              = [[nil]]
+|returns		=A bool only yielding true if the elapsed time is greater than the passed in value.
-|description          = This function will check, whether a certain time has passed after the timer has been created.
+|description		=
-|codedesc             = This will gib the object this script is attached to after 5 seconds have passed.
+Returns true if the elapsed time is past a certain amount of time.
-|code                 = <code lua n>
+|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.
@@ Line 15: / Line 16: @@
      end
 end</code>
-|output               = nil
+|output		= nil
-|}}
+}}