Difference between revisions of "Channel:pop"
(Slight change of grammar.) |
|||
| (7 intermediate revisions by 3 users not shown) | |||
| 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 | + | 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. | ||
| + | |||
| + | {{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 === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | value = Channel:pop( | + | value = Channel:pop( ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | + | None. | |
=== Returns === | === Returns === | ||
| − | {{param| | + | {{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 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.
|
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
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
