Difference between revisions of "Channel:push"

(Created page with "{{newin|0.9.0|090|type=function}} Send a message to the thread channel. The name of the message can be any string. The value of the message can be a boolean, string, number ...")
 
m (Return ID in LOVE 11.0)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Send a message to the thread channel.
+
Send a message to the thread Channel.
  
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. Foreign userdata (Lua's files, LuaSocket, ...), functions or tables are not supported.
+
See [[Variant]] for the list of supported types.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Thread:push( name , value )
+
id = Channel:push( value )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|name|The name of the message.}}
+
{{param|Variant|value|The contents of the message.}}
{{param|string|name|The contents of the message.}}
 
 
=== Returns ===
 
=== Returns ===
None.
+
{{New feature|11.0|
 +
{{param|number|id|Identifier which can be supplied to [[Channel:hasRead]]}}
 +
|110}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 +
* [[Channel:pop]]
 +
* [[Channel:supply]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Send a message to a named thread channel.}}
+
{{#set:Description=Send a message to a thread Channel.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:push}}
 
{{i18n|Channel:push}}

Latest revision as of 11:23, 11 June 2018

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

Send a message to the thread Channel.

See Variant for the list of supported types.

Function

Synopsis

id = Channel:push( value )

Arguments

Variant value
The contents of the message.

Returns

Available since LÖVE 11.0
number id
Identifier which can be supplied to Channel:hasRead

See Also

Other Languages