Difference between revisions of "Thread:peek"

(Initial version)
 
m
 
(11 intermediate revisions by 9 users not shown)
Line 1: Line 1:
Receive a message from a thread, but leave it in the message queue.
+
{{newinoldin|[[0.7.0]]|070|[[0.9.0]]|090|type=function|text=It has been moved to the [[Channel]] api}}
 +
Retrieves the value of a message, but leaves it in the thread's message box. 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.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Source:peek(name)
+
value = Thread:peek( name )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|name|The name of the message.}}
 
{{param|string|name|The name of the message.}}
 
=== Returns ===
 
=== Returns ===
{{param|value|value|The contents of the message.}}
+
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Thread]]
 
* [[parent::Thread]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Receive a message from a thread, but leave it in the message queue.}}
+
{{#set:Description=Receive a message from a thread, but leave it in the message box.}}
 +
== Other Languages ==
 +
{{i18n|Thread:peek}}

Latest revision as of 22:32, 27 December 2015

Available since LÖVE 0.7.0 and removed in LÖVE 0.9.0
It has been moved to the Channel api.

Retrieves the value of a message, but leaves it in the thread's message box. 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.

Function

Synopsis

value = Thread:peek( name )

Arguments

string name
The name of the message.

Returns

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

See Also

Other Languages