Chatbox

This page documents the hooks defined by the chatbox module.

---

CanManageFilteredWords(client)View Source

Purpose

Determines whether a player is allowed to manage the chat filter word list.

Realm

Server

Parameters

Player client The player whose chat filter management permission should be checked.

Returns

boolean True if the player has the manageChatFilter privilege.

---

ChatboxTextAdded()View Source

Purpose

Called on the client after a new chat line is added to the chatbox.

Realm

Client

---

ChatParsed(client, chatType, message, anonymous)View Source

Purpose

Allows code to adjust a parsed chat message before it is dispatched.

Realm

Shared

Parameters

Player client The player who sent the message.

string chatType The parsed chat class unique ID.

string message The parsed message text.

boolean anonymous Whether the message is currently treated as anonymous.

Returns

string|nil, string|nil, boolean|nil Return replacement values for the chat type, message, or anonymous state.

---

GetOOCDelay(speaker)View Source

Purpose

Allows code to override the out-of-character chat cooldown for a player.

Realm

Shared

Parameters

Player speaker The player attempting to send an OOC message.

Returns

number|nil Return a replacement OOC delay in seconds.

---

OnOOCMessageSent(client, message)View Source

Purpose

Called after an out-of-character message is accepted for sending.

Realm

Shared

Parameters

Player client The player who sent the OOC message.

string message The message text that was sent.

---

PlayerMessageSend(client, chatType, message, anonymous, receivers)View Source

Purpose

Allows code to adjust the final chat message text before recipients receive it.

Realm

Client / Server

Parameters

Player client The player who sent the message.

string chatType The chat class unique ID being used.

string message The message text that is about to be sent.

boolean anonymous Whether the message is anonymous.

table receivers optional The resolved recipient list when available.

Returns

string|nil Return replacement message text to override the final output.

---