Difference between revisions of "Thread:get"

m (Remove link to third party lib (TSerial).)
Line 1: Line 1:
 
{{newin|[[0.8.0]]|080|type=function|text=It has been renamed from [[Thread:receive]]}}
 
{{newin|[[0.8.0]]|080|type=function|text=It has been renamed from [[Thread:receive]]}}
Get a value (cross-threads).
+
Retrieves the value of a message and removes it from 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.
Returns nil when a message is not in the message box.
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 10: Line 9:
 
{{param|string|name|The name of the message.}}
 
{{param|string|name|The name of the message.}}
 
=== Returns ===
 
=== Returns ===
{{param|boolean, number, string or userdata|value|The contents of the message or nil when no message in message box.}}
+
{{param|boolean, number, string or LÖVE userdata|value|The contents of the message or nil when no message in message box.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Thread]]
 
* [[parent::Thread]]

Revision as of 07:00, 18 October 2012

Available since LÖVE 0.8.0
It has been renamed from Thread:receive.

Retrieves the value of a message and removes it from 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:get(name)

Arguments

string name
The name of the message.

Returns

boolean, number, string or LÖVE userdata value
The contents of the message or nil when no message in message box.

See Also

Other Languages