Difference between revisions of "Channel:peek"

Revision as of 06:29, 5 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.

value = Channel:peek( )

None.

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

@@ Line 1: / Line 1: @@
 {{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.
+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 ===
 <source lang="lua">
-value = Channel:peek( name )
+value = Channel:peek( )
 </source>
 === Arguments ===
-{{param|string|name|The name of the message.}}
+None.
 === Returns ===
 {{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
@@ Line 13: / Line 15: @@
 * [[parent::Channel]]
 [[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 ==
 {{i18n|Channel:peek}}