🗝️ Events

🖥️ Client-Side Events

SetChatVisible(visible)

Sets the chat UI visibility and focus.

CopySetChatVisible(true)  -- Show chat
SetChatVisible(false) -- Hide chat

• visible (boolean) — Show (true) or hide (false) the chat.
• When visible:
  • Initializes server commands.
  • Sends locales and colors to the NUI UI.

chat:receiveServerSuggestions

CopyRegisterNetEvent('chat:receiveServerSuggestions', function(serverSuggestions) end)

• Receives server-side command suggestions.
• Combines them with client-side commands automatically.
• Sends combined suggestions to NUI for autocomplete.

chat:addMessage

CopyRegisterNetEvent('chat:addMessage', function(messageData) end)

• Displays a message in the chat.
• Supports two formats:
  • String — Displays as a system message.
  • Table — Supports author, args, and optional template.

chat:displayMessage

CopyRegisterNetEvent('chat:displayMessage', function(msgType, title, message, channelData) end)

• Displays a message in a specific chat channel.
• Parameters:
  • msgType — system, template, or channel.
  • title — Author or channel name.
  • message — Message content.
  • channelData — Channel configuration (prefix, color, avatar).

chat:clear & chat:clearAll

CopyRegisterNetEvent('chat:clear')
RegisterNetEvent('chat:clearAll')

• Clears all chat messages from the UI.

NUI Callbacks

close

CopyRegisterNUICallback('close', function(_, cb) end)

• Triggered when the NUI chat window is closed.
• Sets chat visibility to false.

sendMessage

CopyRegisterNUICallback('sendMessage', function(data, cb) end)

• Triggered when a message is sent from the chat UI.
• Executes commands starting with /.
• Sends normal messages as OOC to the server.

🌐 Server-Side Events

chat:sendOocMessage

CopyRegisterServerEvent('chat:sendOocMessage')
AddEventHandler('chat:sendOocMessage', function(message) end)

• Sends an OOC message to all players.
• Uses player’s real name instead of character name.

chat:init

CopyRegisterServerEvent('chat:init')
AddEventHandler('chat:init', function() end)

• Initializes player commands when chat opens.
• Refreshes available commands for the client.

chat:addMessage

CopyRegisterServerEvent('chat:addMessage')
AddEventHandler('chat:addMessage', function(message, author) end)

• Sends a system message to all clients.
• author defaults to Config.Locales.system_prefix.

Player Connection Events

playerJoining

• Refreshes commands for joining players.

onServerResourceStart

• Refreshes commands for all players when resource starts.

📜 Server Commands Related to Chat

Channel Commands

• Automatically registered for each channel in Config.Channels (except /ooc).
• Sends messages to the appropriate chat channel using chat:displayMessage.

/announcement

• Admin-only command to send a system-wide message.
• Usage: /announcement [message]

/clear

• Admin-only command to clear the chat for all players.