Parallel.waitForAny - Revision history

Dan200: Removed very misleading incorrect note

2016-01-27T21:54:49Z

Removed very misleading incorrect note

MKlegoman357: Fixed

2014-04-10T18:19:55Z

Fixed

Bomb Bloke: Some attempts at clarification.

2014-02-12T06:26:42Z

Some attempts at clarification.

AfterLifeLochie: Function -> Function (type)

2012-11-30T18:49:03Z

Function -> Function (type)

AfterLifeLochie: Moved to CAT:APIFunctions

2012-11-28T18:35:51Z

Moved to CAT:APIFunctions

108.78.191.194 at 19:40, 14 September 2012

2012-09-14T19:40:30Z

Banane9: Created the Page

2012-07-07T19:26:51Z

Created the Page

New page

{{Function
|name=parallel.waitForAny
|args= function1, function2, so on
|returns = ?
|api=parallel
|addon=ComputerCraft
|desc=Lets you run multiple functions at the same time.
|examples=
{{Example
|desc=Tells the computer to run function1 and function2 at the same time. Will broadcast what the User enters and prints what it receives over rednet. Both will stop when either something is printed or the user entered something.
|code=function1 = [[function]]()
[[print]] ([[rednet.receive]]())
end
function2 = [[function]]()
[[rednet.broadcast]] ([[read]]())
end
parallel.waitForAny (function1, function2)
|output=Either it prints what it received via rednet, or it broadcasts the message the user typed.
}}
}}

@@ Line 1: / Line 1: @@
 {{Function
 |name=parallel.waitForAny
-|args= function1, function2, so on
+|args={{type|function}} function1, {{type|function}} function2, ...
-|returns = A number indicating which function completed based on argument order
+|returns = {{type|number}} indicating which function has completed based on argument order
 |api=parallel
 |addon=ComputerCraft
-|desc=Lets you run multiple functions at the same time, alternating between them until any happen to finish. Note that it takes ''function names'' as parameters (eg "function1", "function2", etc), as opposed to ''function calls'' (eg "function1()", "function2()", etc).<br><br>
+|desc=Lets you run multiple functions at the same time, alternating between them until any happen to finish. Note that it takes ''function names'' as parameters (eg "function1", "function2", etc), as opposed to ''function calls'' (eg "function1()", "function2()", etc).
-−
-The functions are not actually executed simultaniously, but rather this API will automatically switch between them whenever they yield (eg whenever they call [[Coroutine.yield|coroutine.yield()]], or functions that call that - eg [[Os.pullEvent|os.pullEvent()]] - or functions that call ''that'', etc - basically, anything that causes the function to "pause").<br><br>
-−
-Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, most anything that causes the script to pause - eg [[Os.sleep|sleep()]], [[Rednet.receive|rednet.receive()]], most of the [[Turtle_(API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
 |examples=
 {{Example
-|desc=Tells the computer to run function1 and function2 at the same time. Will broadcast what the user enters or prints what it receives over rednet, depending on what happens first.
+|desc=Tells the computer to run <var>receive</var >and <var>send</var> the same time. Will broadcast what the user enters or prints what it receives over rednet, depending on what happens first.
-|code=function1 = [[Function (type)|function]]()  -- Define function1.
+|code= local function receive ()  -- Define function1.
-   [[print]] ([[rednet.receive]]())
+   [[print]]([[rednet.receive]]())
   end
-  [[Function (type)|function]] function2()  -- Define function2.
+  local function send ()  -- Define function2.
-   [[rednet.broadcast]] ([[read]]())
+   [[rednet.broadcast]]([[read]]())
   end
-  parallel.waitForAny (function1, function2)  -- Run both functions in parallel until one finishes.
+  '''parallel.waitForAny(receive, send)'''  -- Run both functions in parallel until one finishes.
 |output=Either it prints what it received via rednet, or it broadcasts the message the user typed.
 }}

← Older revision		Revision as of 18:35, 28 November 2012
Line 19:		Line 19:
	}}		}}
	}}		}}
		+
		+	[[Category:API_Functions]]

@@ Line 9: / Line 9: @@
 {{Example
 |desc=Tells the computer to run function1 and function2 at the same time. Will broadcast what the User enters and prints what it receives over rednet. Both will stop when either something is printed or the user entered something.
-|code=function1 = [[function]]()
+|code=function1 = [[Function (type)|function]]()
    [[print]] ([[rednet.receive]]())
   end
-  function2 = [[function]]()
+  function2 = [[Function (type)|function]]()
    [[rednet.broadcast]] ([[read]]())
   end