Difference between revisions of "Thread:receive"

m (value → Variant)
 
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{newinoldin|[[0.7.0]]|070|[[0.8.0]]|080|type=function|text=It has been renamed to [[Thread:get]]}}
 
Receive a message from a thread.
 
Receive a message from a thread.
Returns nil when message is not in the queue.
+
Returns nil when a message is not in the message box.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Source:getName(name)
+
value = Thread:receive(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|Variant|value|The contents of the message or nil when no message in message box.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Thread]]
 
* [[parent::Thread]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Receive a message from a thread.}}
 
{{#set:Description=Receive a message from a thread.}}
 +
== Other Languages ==
 +
{{i18n|Thread:receive}}

Latest revision as of 11:08, 31 January 2017

Available since LÖVE 0.7.0 and removed in LÖVE 0.8.0
It has been renamed to Thread:get.

Receive a message from a thread. Returns nil when a message is not in the message box.

Function

Synopsis

value = Thread:receive(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