Difference between revisions of "Thread:peek"

(Remove link to third party lib (TSerial).)
Line 1: Line 1:
 
{{newin|[[0.7.0]]|070|type=function}}
 
{{newin|[[0.7.0]]|070|type=function}}
Receive a message from a thread, but leave it in the message box.
+
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 ===
Line 9: Line 9:
 
{{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]]

Revision as of 07:03, 18 October 2012

Available since LÖVE 0.7.0
This function is not supported in earlier versions.

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