Difference between revisions of "Channel:demand"

m (value → Variant)
(Add new timeout variant)
Line 12: Line 12:
 
=== Returns ===
 
=== Returns ===
 
{{param|Variant|value|The contents of the message.}}
 
{{param|Variant|value|The contents of the message.}}
 +
 +
== Function ==
 +
{{newin|[[0.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 ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]

Revision as of 16:48, 7 January 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.

Function

Synopsis

value = Channel:demand( )

Arguments

None.

Returns

Variant value
The contents of the message.

Function

Available since LÖVE 0.11.0
This variant is not supported in earlier versions.

Synopsis

value = Channel:demand( timeout )

Arguments

number timeout
The maximum amount of time to wait.

Returns

Variant value
The contents of the message or nil if the timeout expired.

See Also

Other Languages