ClearChatBox

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

This example deletes messages for all players

local players = getElementsByType('player')

for k, v in pairs(players) do
  clearChatBox(v)
end

See Also

• getMaxPlayers
• getServerConfigSetting
• getServerHttpPort
• getServerName
• getServerPassword
• getServerPort
• isGlitchEnabled
• setGlitchEnabled
• setMaxPlayers
• setServerConfigSetting
• setServerPassword
• shutdown