Difference between revisions of "Channel:demand"

m (Removed excessive links)
m
Line 2: Line 2:
 
Retrieves the value of a Channel message and removes it from the message queue.
 
Retrieves the value of a Channel message and removes it from the message queue.
  
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.
+
The value of the message can be a boolean, string, number, LÖVE userdata, or a simple flat table. It waits until a message is in the queue then returns the message value.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 11: Line 11:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
+
{{param|boolean, number, string, LÖVE userdata, or flat table|value|The contents of the message.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 
* [[Channel:pop]]
 
* [[Channel:pop]]
 +
* [[Channel:push]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Wait for and retrieve the value of a Channel message.}}
 
{{#set:Description=Wait for and retrieve the value of a Channel message.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:demand}}
 
{{i18n|Channel:demand}}

Revision as of 21:24, 1 September 2013

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.

The value of the message can be a boolean, string, number, LÖVE userdata, or a simple flat table. It waits until a message is in the queue then returns the message value.

Function

Synopsis

value = Channel:demand( )

Arguments

None.

Returns

boolean, number, string, LÖVE userdata, or flat table value
The contents of the message.

See Also

Other Languages