ClearChatBox: Difference between revisions
Jump to navigation
Jump to search
m (Few English fixes) |
^iiEcoo'x ) (talk | contribs) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
{{New feature/item|3.0156|1.5. | {{New feature/item|3.0156|1.5.5|14165|This function clears the chatbox. It does not clear the console (F8)}} | ||
==Syntax== | ==Syntax== | ||
Line 27: | Line 27: | ||
This example removes spam caused by outputChatBox | This example removes spam caused by outputChatBox | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
for i=1,10 do | for i=1,10 do | ||
outputChatBox( "spam ..." ) | outputChatBox( "spam ..." ) | ||
Line 34: | Line 33: | ||
clearChatBox() | clearChatBox() | ||
outputChatBox("Chat cleared successfully!") | outputChatBox("Chat cleared successfully!") | ||
</syntaxhighlight> | |||
</section> | |||
<section name="Server" class="server" show="false"> | |||
This example deletes messages for reandom player | |||
<syntaxhighlight lang="lua"> | |||
local RandomPlayer = getRandomPlayer ( ) | |||
clearChatBox(RandomPlayer) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> |
Revision as of 13:19, 27 April 2020
This function clears the chatbox. It does not clear the console (F8)
Syntax
Click to collapse [-]
Clientbool clearChatBox ()
Returns
Returns true if the player's chat was cleared successfully, false otherwise.
Click to collapse [-]
Serverbool clearChatBox ( [ element clearFor = getRootElement() ])
Required Arguments
- clearFor : The player whose chat is to be cleared. By default, this is set to the root element, which will affect all players.
Returns
Returns true if the player's chat was cleared successfully, false otherwise.
Example
Click to collapse [-]
ClientThis example removes spam caused by outputChatBox
for i=1,10 do outputChatBox( "spam ..." ) end clearChatBox() outputChatBox("Chat cleared successfully!")
Click to expand [+]
ServerSee Also
- getFPSLimit
- getMaxPlayers
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- getVersion
- isGlitchEnabled
- isTransferBoxAlwaysVisible
- isTransferBoxVisible
- setFPSLimit
- setGlitchEnabled
- setMaxPlayers
- setServerPassword
- setTransferBoxVisible
- shutdown