Difference between revisions of "Channel:clear"

(Created page with "{{newin|0.9.0|090|type=function}} Clears all the messages in the thread channels queue. The name of the message can be any string. == Function == === Synopsis === <source lan...")
 
m
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Clears all the messages in the thread channels queue. The name of the message can be any string.
+
Clears all the messages in the Channel queue.
 +
{{notice|This function doesn't free up the memory used by a Channel, it needs to be garbage collected to release the memory.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
value = Channel:clear( name )
+
Channel:clear( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|name|The name of the message.}}
+
None.
 
=== Returns ===
 
=== Returns ===
None.
+
Nothing.
 
== See Also ==
 
== See Also ==
 
* [[parent::Channel]]
 
* [[parent::Channel]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Clears all the messages in the thread channels queue.}}
+
{{#set:Description=Clears all the messages in the Channel queue.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Channel:clear}}
 
{{i18n|Channel:clear}}

Latest revision as of 15:00, 20 June 2019

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

Clears all the messages in the Channel queue.

O.png This function doesn't free up the memory used by a Channel, it needs to be garbage collected to release the memory.  


Function

Synopsis

Channel:clear( )

Arguments

None.

Returns

Nothing.

See Also

Other Languages