Os.startTimer - Revision history

Bomb Bloke at 13:24, 17 December 2014

2014-12-17T13:24:07Z

2014-12-17T13:20:43Z

Another example.

2013-12-19T19:53:29Z

Link to the event this function triggers.

2013-11-23T01:51:20Z

Improved example.

2013-09-02T02:34:54Z

2013-09-02T02:34:34Z

2013-07-21T06:30:40Z

Copypasta from Os.sleep. This text should have been here to begin with.

2013-07-18T14:51:50Z

Added NeedsWork tag

2013-07-18T14:51:03Z

Changing cloat to number

2013-07-18T12:47:46Z

Changing int to number

@@ Line 6: / Line 6: @@
 |returns={{type|number}} timerID
 |addon=ComputerCraft
-|desc=Adds a timer which will fire a single [[Timer_(event)|"timer" event]] after <var>time</var> seconds have passed. It also returns a number representing a unique ID for the timer (which will likewise be included said event).<br><br>
+|desc=Adds a timer which will fire a single [[Timer_(event)|"timer" event]] after <var>time</var> seconds have passed. It also returns a number representing the unique ID of the timer (which will likewise be included with said event, allowing you to identify it when you [[os.pullEvent|pull it]]).<br><br>
 Fractions of a second are supported, but only down to a game tick, or 1/20th of a second (0.05s) - note that even a timer set for 0 seconds will not fire until at least a tick has passed. Likewise, given that [[os.sleep|sleep()]] relies on timer events to function (as do other functions that can wait for a set period of time - eg [[rednet.receive|rednet.receive()]]), sleep(1.01) and sleep(1.05) would both wait for at least 1.05 seconds.

@@ Line 1: / Line 1: @@
 {{lowercase}}
 {{Function
- |name=os.startTimer
+|name=os.startTimer
- |args={{type|number}} time
+|args={{type|number}} time
- |api=OS
+|api=OS
- |returns={{type|number}} timerID
+|returns={{type|number}} timerID
- |addon=ComputerCraft
+|addon=ComputerCraft
- |desc=Adds a timer which will fire a [[Timer_(event)|"timer" event]] once after <var>time</var> seconds have passed. It returns an int which acts as a unique ID for the timer. Fractions of a second are supported, but only down to a game tick, or 1/20 of a second (0.05s). Times are rounded up to the next tick, so os.sleep(1.01) and os.sleep(1.05) both wait for 1.05 seconds.
+|desc=Adds a timer which will fire a single [[Timer_(event)|"timer" event]] after <var>time</var> seconds have passed. It also returns a number representing a unique ID for the timer (which will likewise be included said event).<br><br>
- |examples=
 {{Example
 |desc=Yields until 3 seconds have passed.
-|code=local myTimer = os.startTimer(3)<br>while true do<br>  local event,timerID = os.pullEvent("timer")<br>  if timerID == myTimer then break end<br>end
+|code= local myTimer = os.startTimer(3)
 }}
 }}
 [[Category:Lua_Core_Functions]]

@@ Line 6: / Line 6: @@
   |returns={{type|number}} timerID
   |addon=ComputerCraft
-  |desc=Adds a timer which will fire a "timer" event once after <var>time</var> seconds have passed. It returns an int which acts as a unique ID for the timer. Fractions of a second are supported, but only down to a game tick, or 1/20 of a second (0.05s). Times are rounded up to the next tick, so os.sleep(1.01) and os.sleep(1.05) both wait for 1.05 seconds.
+  |desc=Adds a timer which will fire a [[Timer_(event)|"timer" event]] once after <var>time</var> seconds have passed. It returns an int which acts as a unique ID for the timer. Fractions of a second are supported, but only down to a game tick, or 1/20 of a second (0.05s). Times are rounded up to the next tick, so os.sleep(1.01) and os.sleep(1.05) both wait for 1.05 seconds.
   |examples=
 {{Example

@@ Line 9: / Line 9: @@
   |examples=
 {{Example
-|desc=Yields until 3 seconds have passed
+|desc=Yields until 3 seconds have passed.
-|code=os.startTimer(3)<br>os.pullEvent(timer)
+|code=local myTimer = os.startTimer(3)<br>while true do<br>  local event,timerID = os.pullEvent("timer")<br>  if timerID == myTimer then break end<br>end
 }}
 }}
 [[Category:Lua_Core_Functions]]

← Older revision		Revision as of 02:34, 2 September 2013
Line 1:		Line 1:
−	~~{{NeedsWork\|This page needs an example}}~~
	{{lowercase}}		{{lowercase}}
	{{Function		{{Function

← Older revision		Revision as of 14:51, 18 July 2013
Line 1:		Line 1:
		+	{{NeedsWork\|This page needs an example}}
	{{lowercase}}		{{lowercase}}
	{{Function		{{Function