Difference between revisions of "Channel:peek"

m (correct return type to ''value'')
m (value → Variant)
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
Retrieves the value of a Channel message, but leaves it in the queue.
 
Retrieves the value of a Channel message, but leaves it in the queue.
  
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.
+
It returns nil if there's no message 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]]
 +
* [[Channel:pop]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Receive a message from a thread Channel, but leave it in the queue.}}
 
{{#set:Description=Receive a message from a thread Channel, but leave it in the queue.}}
 +
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:peek}}
 
{{i18n|Channel:peek}}

Latest revision as of 11: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, but leaves it in the queue.

It returns nil if there's no message in the queue.

Function

Synopsis

value = Channel:peek( )

Arguments

None.

Returns

Variant value
The contents of the message.

See Also


Other Languages