Difference between revisions of "ClearChatBox"

From Multi Theft Auto: Wiki
m
m (Example)
 
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>
 +
 +
==Example==
 +
<section name="Server" class="server" show="false">
 +
This example deletes messages for all players
 +
<syntaxhighlight lang="lua">
 +
 +
local players = getElementsByType('player')
 +
 +
for k, v in pairs(players) do
 +
  clearChatBox(v)
 +
end
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</section>
 
</section>

Latest revision as of 14:44, 6 August 2019

This function clears the chatbox. It does not clear the console (F8)

Syntax

Click to collapse [-]
Client
bool clearChatBox ()

Returns

Returns true if the player's chat was cleared successfully, false otherwise.

Click to collapse [-]
Server
bool 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 [-]
Client

This example removes spam caused by outputChatBox

for i=1,10 do
  outputChatBox( "spam ..." )
end

clearChatBox()
outputChatBox("Chat cleared successfully!")

Example

Click to expand [+]
Server

See Also