Difference between revisions of "Channel:peek"

m
m (Removed excessive links)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
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.
 
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.
Line 15: Line 15:
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 
[[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}}

Revision as of 00:41, 17 June 2013

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.

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.

Function

Synopsis

value = Channel:peek( )

Arguments

None.

Returns

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

See Also

Other Languages