Difference between revisions of "Channel:demand"

m (0.11.0 -> 11.0)
m
Line 20: Line 20:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|timeout|The maximum amount of time to wait.}}
+
{{param|number|timeout|The maximum amount of time to wait, in seconds.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|Variant|value|The contents of the message or nil if the timeout expired.}}
 
{{param|Variant|value|The contents of the message or nil if the timeout expired.}}

Revision as of 11:05, 7 July 2021

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 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, in seconds.

Returns

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

See Also

Other Languages