Difference between revisions of "Channel:pop"

m
m (value → Variant)
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, LÖVE userdata, or a simple flat table. It returns nil if there are no messages in the queue.
+
It returns nil if there are no messages in the queue.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 11: Line 11:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|value|value|The contents of the message.}}
+
{{param|Variant|value|The contents of the message.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]

Revision as of 12:10, 31 January 2017

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 returns nil if there are no messages in the queue.

Function

Synopsis

value = Channel:pop( )

Arguments

None.

Returns

Variant value
The contents of the message.

See Also

Other Languages