Difference between revisions of "ClearChatBox"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Few English fixes)
m
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Server client function}}  
 
{{Server client function}}  
{{New feature/item|3.0156|1.5.6|14198|This function clears the chatbox. It does not clear the console (F8)}}
+
{{New feature/item|3.0156|1.5.5|14165|This function clears the chatbox. It does not clear the console (F8)}}
  
 
==Syntax==
 
==Syntax==

Revision as of 21:52, 31 August 2018

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!")

See Also

BETA: FROM VERSION 1.5.8 r20788 ONWARDS
BETA: FROM VERSION 1.5.8 r20788 ONWARDS