Difference between revisions of "Thread:get"

(value → Variant)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{newin|[[0.8.0]]|080|type=function|text=It has been renamed from [[Thread:receive]]}}
+
{{newinoldin|[[0.8.0]]|080|[[0.9.0]]|090|type=function|text=It has been moved to the [[Channel]] api}}
{{oldin|[[0.9.0]]|090|type=function|text=It has been moved to the [[Channel]] api.}}
+
Retrieves the value of a message and removes it from the thread's message box.  
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 ==
 
== 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 LÖVE userdata|value|The contents of the message or nil when no message in message box.}}
+
{{param|Variant|value|The contents of the message or nil when no message in message box.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Thread]]
 
* [[parent::Thread]]

Latest revision as of 11:08, 31 January 2017

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

Retrieves the value of a message and removes it from the thread's message box.

Function

Synopsis

value = Thread:get( name )

Arguments

string name
The name of the message.

Returns

Variant value
The contents of the message or nil when no message in message box.

See Also

Other Languages