Difference between revisions of "Channel:peek"

m (value → Variant)
 
(4 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, but leaves it in the thread channels 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 with the given name.
+
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 ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Channel:peek( name )
+
value = Channel:peek( )
 
</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|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