Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

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

Syntax

bool clearChatBox ( )

Returns

• bool: value

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

Code Examples

server

This example adds an admin command to clear the chatbox for everyone

function cmdClearChat(p, cmd)
    if not isPlayerStaff(p) then return end
    clearChatBox()
end
addCommandHandler("clearchat", cmdClearChat)

-- Utility function
local staffACLs = {
    aclGetGroup("Admin"),
    aclGetGroup("Moderator")
}

function isPlayerStaff(p)
  if isElement(p) and getElementType(p) == "player" and not isGuestAccount(getPlayerAccount(p)) then
    local object = getAccountName(getPlayerAccount(p))

    for _, group in ipairs(staffACLs) do
      if isObjectInACLGroup("user." .. object, group) then
        return true
      end
    end
  end
  return false
end

See Also

Output Functions

• clearChatBox
• clearDebugBox
• isChatInputBlocked
• isChatVisible
• outputChatBox
• outputConsole
• outputDebugString
• outputServerLog
• showChat

Reference

• Scripting Functions