Difference between revisions of "Channel:pop"

m (Removed excessive links)
 
(4 intermediate revisions by 3 users not shown)
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 returns nil if there are no messages in the queue.
+
It returns nil if there are no messages in the queue.
 +
 
 +
{{notice|This function doesn't free up the memory used by a Channel, it needs to be garbage collected to release the memory.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 11: Line 13:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
+
{{param|Variant|value|The contents of the message.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 +
* [[Channel:push]]
 +
* [[Channel:demand]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Retrieve the value of a Channel message.}}
 
{{#set:Description=Retrieve the value of a Channel message.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:pop}}
 
{{i18n|Channel:pop}}

Latest revision as of 19:25, 9 March 2018

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.

O.png This function doesn't free up the memory used by a Channel, it needs to be garbage collected to release the memory.  


Function

Synopsis

value = Channel:pop( )

Arguments

None.

Returns

Variant value
The contents of the message.

See Also

Other Languages