Difference between revisions of "Channel:pop"

(Slight change of grammar.)
m
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Retrieves the value of a message and removes it from the thread channels message queue. The name of the message can be any string. The value of the message can be a boolean, string, number or a LÖVE userdata. It returns nil if there are no messages in the 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 returns nil if there are no messages in the queue.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Channel:pop( name )
+
value = Channel:pop( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|name|The name of the message.}}
+
None.
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
 
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
Line 13: Line 13:
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Retrieve the value of a message.}}
+
{{#set:Description=Retrieve the value of a [[Channel]] message.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:pop}}
 
{{i18n|Channel:pop}}

Revision as of 06:23, 5 June 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 or a LÖVE userdata. It returns nil if there are no messages in the queue.

Function

Synopsis

value = Channel:pop( )

Arguments

None.

Returns

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

See Also

Other Languages