Os.sleep - Revision history

MKlegoman357: Fixed/Expanded

2014-06-03T22:46:45Z

Fixed/Expanded

Daniel-Dane at 13:12, 29 July 2013

2013-07-29T13:12:17Z

AfterLifeLochie: Updated references from "os" to "OS"

2012-11-30T14:08:50Z

Updated references from "os" to "OS"

AfterLifeLochie: Moved to CAT:LuaCoreFunctions

2012-11-28T18:49:59Z

Moved to CAT:LuaCoreFunctions

Tertiary at 02:47, 21 September 2012

2012-09-21T02:47:58Z

Pinkishu: moved Os.sleep( timeout ) to Os.sleep

2012-05-30T07:35:04Z

moved Os.sleep( timeout ) to Os.sleep

Techzune: Added the function template.

2012-05-12T03:08:53Z

Added the function template.

24.24.175.109 at 05:10, 19 April 2012

2012-04-19T05:10:36Z

83.145.64.161: Created page with "Causes the computer to sleep for a number of seconds. This is useful in unexpected ways, as if you try to send a pulse of redstone with: rs([side], true) rs([side], false) n..."

2012-04-08T00:45:52Z

Created page with "Causes the computer to sleep for a number of seconds. This is useful in unexpected ways, as if you try to send a pulse of redstone with: rs([side], true) rs([side], false) n..."

New page

Causes the computer to sleep for a number of seconds. This is useful in unexpected ways, as if you try to send a pulse of redstone with:

rs([side], true)
rs([side], false)

nothing will happen, as there are no in-game ticks between such actions.

Args: (Int? Decimal (Double, etc)?) seconds.

TODO: Is it an int value or a decimal value?

@@ Line 2: / Line 2: @@
 {{Function
 |name=os.sleep
-|args=timeout
+|returns={{type|nil}}
 |api=OS
 |addon=ComputerCraft
-|desc=Pauses the computer for a number of seconds. 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. You can also use sleep( timeout ).
+|desc=Pauses the computer for a number of seconds. 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 <var>os.sleep(1.01)</var> and <var>os.sleep(1.05)</var> both wait for 1.05 seconds. You can also use <var>sleep( timeout )</var>.
 |examples=
 {{Example
 |desc=Pause for 3 seconds.
-|code=os.sleep( 3 )
+|code='''os.sleep( 3 )'''
 }}
 }}
@@ Line 15: / Line 16: @@
 == Concerns when using events ==
 The implementation of the sleep function is as follows:
-If you are using events and the sleep function at the same time, you may notice events received during the sleep never firing. The sleep function continually loops, emptying the event queue, until the timer event fires. If you still want to sleep, you should create your own sleep function which takes care of the events while sleeping. One such function would be:
+ function sleep( _nTime )
-<pre>
+   local timer = [[os.startTimer]]( _nTime )
--- Replacement for sleep(s), which passes on events instead of dropping them
-function wait(s)
+   repeat
-    local timer = os.startTimer(s)
+     local sEvent, param = [[os.pullEvent]]( "timer" )
-    while true do
+   until param == timer
-        local event = {os.pullEvent()}
+ end
-        if (event[1] == "timer" and event[2] == timer) then
-            break
-        else
-            processMeessages(event)
-        end
-    end
-end
-</pre>
 [[Category:Lua_Core_Functions]]

@@ Line 5: / Line 5: @@
 |api=OS
 |addon=ComputerCraft
-|desc=Pauses the computer for a number of seconds. 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=Pauses the computer for a number of seconds. 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. You can also use sleep( timeout ).
 |examples=
 {{Example
-|desc=Pause for 3 seconds
+|desc=Pause for 3 seconds.
 |code=os.sleep( 3 )
 }}
 }}
-You can also just use sleep( timeout )
 [[Category:Lua_Core_Functions]]

@@ Line 3: / Line 3: @@
 |name=os.sleep
 |args=timeout
-|api=os
+|api=OS
 |addon=ComputerCraft
 |desc=Pauses the computer for a number of seconds. 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.

← Older revision		Revision as of 18:49, 28 November 2012
Line 13:		Line 13:
	}}		}}
	You can also just use sleep( timeout )		You can also just use sleep( timeout )
		+
		+	[[Category:Lua_Core_Functions]]

@@ Line 5: / Line 5: @@
 |api=os
 |addon=ComputerCraft
-|desc=Pauses the computer for a number of seconds
+|desc=Pauses the computer for a number of seconds. 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

← Older revision	Revision as of 07:35, 30 May 2012
(No difference)

@@ Line 6: / Line 6: @@
 nothing will happen, as there are no in-game ticks between such actions.
-Args: (Int? Decimal (Double, etc)?) seconds.
+Args: (num) seconds.
-TODO: Is it an int value or a decimal value?
+In lua there is no int or double its just numbers.