Difference between revisions of "Channel:pop"

(Created page with "{{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...")
 
(Slight change of grammar.)
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's no message in the queue.
+
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.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===

Revision as of 11:07, 20 May 2013

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

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.

Function

Synopsis

value = Channel:pop( name )

Arguments

string name
The name of the message.

Returns

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

See Also

Other Languages