Difference between revisions of "Channel:demand"

Revision as of 14:19, 22 December 2018

Available since LÖVE 0.9.0

This function is not supported in earlier versions.

Retrieves the value of a Channel message and removes it from the message queue.

It waits until a message is in the queue then returns the message value.

value = Channel:demand( )

None.

Available since LÖVE 11.0

This variant is not supported in earlier versions.

value = Channel:demand( timeout )

@@ Line 1: / Line 1: @@
 {{newin|[[0.9.0]]|090|type=function}}
-Retrieves the value of a message and removes it from the thread channels message queue. The name of the message can be any string. The value of the message can be a boolean, string, number or a LÖVE userdata. It waits until a message is in the queue then returns the message value.
+Retrieves the value of a Channel message and removes it from the message queue.
+It waits until a message is in the queue then returns the message value.
 == Function ==
 === Synopsis ===
 <source lang="lua">
-value = Channel:demand( name )
+value = Channel:demand( )
 </source>
 === Arguments ===
-{{param|string|name|The name of the message.}}
+None.
 === Returns ===
-{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
+{{param|Variant|value|The contents of the message.}}
+== Function ==
+{{newin|[[11.0]]|110|type=variant}}
+=== Synopsis ===
+<source lang="lua">
+value = Channel:demand( timeout )
+</source>
+=== Arguments ===
+{{param|number|timeout|The maximum amount of time to wait.}}
+=== Returns ===
+{{param|Variant|value|The contents of the message or nil if the timeout expired.}}
 == See Also ==
 * [[parent::Channel]]
+* [[Channel:supply]]
+* [[Channel:pop]]
 [[Category:Functions]]
-{{#set:Description=Wait for and retrieve the value of a message.}}
+{{#set:Description=Wait for and retrieve the value of a Channel message.}}
 == Other Languages ==
 {{i18n|Channel:demand}}