Channel:demand

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. Given as a decimal, accurate to the millisecond.

Returns

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

See Also

Other Languages