This event is triggered when a player chats inside the chatbox.

Parameters

string message, int messageType

• message: a string representing the message typed into the chat.

• messageType: an int value representing the message type: 0: normal message 1: action message (/me) 2: team message 3: private message 4: internal message

Source

element: The source of this event is the player who sent the chatbox message.

Canceling

If this event is canceled, the game's chat system won't deliver the posts. You may use outputChatBox to send the messages then. Cancelling this event also means the chat will not appear in the server console or logs. If you want chat logging, you will have to add a call to outputServerLog - See the second example.

Code Examples

Example 1 Example 2 Example 3

server

This example limits receiving of chat messages to area around the player who sent the message, also blocking action and team text.

local chatRadius = 20 -- define our chat radius

function onPlayerChatSendMessageToNearbyPlayers(messageText, messageType)
  local normalMessage = (messageType == 0) -- we will only send normal chat messages, action and team types will be ignored

  if (not normalMessage) then -- it's not normal message
    return false -- do not continue
  end

  local playerName = getPlayerName(source)
  local playerX, playerY, playerZ = getElementPosition(source) -- get position of player who sent the message
  local playerInterior = getElementInterior(source) -- get interior of same player
  local playerDimension = getElementDimension(source) -- dimension as well
  local nearbyPlayers = getElementsWithinRange(playerX, playerY, playerZ, chatRadius, "player", playerInterior, playerDimension) -- get nearby players within given radius
  local messageToOutput = playerName..": "..messageText

  outputChatBox(messageToOutput, nearbyPlayers, 255, 255, 255, true) -- output message to them
  cancelEvent() -- block the original message by cancelling this event
end
addEventHandler("onPlayerChat", root, onPlayerChatSendMessageToNearbyPlayers)

server

This example implements colored player names in chat.

--This function is executed when a player joins, it sets the player's name-tag color to a random color.

local function playerJoin()
  local red, green, blue = math.random (50, 255), math.random (50, 255), math.random (50, 255)
        setPlayerNametagColor(source, red, green, blue)
end
addEventHandler ("onPlayerJoin", root, playerJoin)

--This function is executed when a player says something in chat, it outputs the player's message, with their nick colored to match their name tag color.

local function playerChat(message, messageType)
  if messageType == 0 then --Global (main) chat
                cancelEvent()
                local red, green, blue = getPlayerNametagColor(source)
    outputChatBox(getPlayerName(source)..": #FFFFFF"..message, root, red, green, blue, true )
    outputServerLog("CHAT: "..getPlayerName(source)..": "..message) -- Because we cancelled the onPlayerChat event, we need to log chat manually.
  end
end
addEventHandler("onPlayerChat", root, playerChat)

server

This is a script that kills any player that says 'kill'.

function onChat(message, messageType)
    if string.find(message, 'kill') then  -- Searches for the string 'kill' in the message sent
        killPed ( source, source ) -- Kills that player that typed the string 'kill'
    end
end
addEventHandler("onPlayerChat", root, onChat)

See Also

Player Events

• onClientPlayerChangeNick
• onClientPlayerChoke
• onClientPlayerDamage
• onClientPlayerHeliKilled
• onClientPlayerHitByWaterCannon
• onClientPlayerJoin
• onClientPlayerPickupLeave
• onClientPlayerPickupHit
• onClientPlayerRadioSwitch
• onClientPlayerQuit
• onClientPlayerStealthKill
• onClientPlayerSpawn
• onClientPlayerStuntFinish
• onClientPlayerStuntStart
• onClientPlayerVehicleEnter
• onClientPlayerTarget
• onClientPlayerVehicleExit
• onClientPlayerVoicePause
• onClientPlayerVoiceResumed
• onClientPlayerVoiceStart
• onClientPlayerVoiceStop
• onClientPlayerWasted
• onClientPlayerWeaponFire
• onClientPlayerWeaponSwitch
• onPlayerACInfo
• onPlayerBan
• onPlayerChangeNick
• onPlayerChangesProtectedData
• onPlayerChangesWorldSpecialProperty
• onPlayerClick
• onPlayerCommand
• onPlayerChat
• onPlayerConnect
• onPlayerContact
• onPlayerDetonateSatchels
• onPlayerDiscordJoin
• onPlayerDamage
• onPlayerJoin
• onPlayerLogin
• onPlayerLogout
• onPlayerMarkerHit
• onPlayerMarkerLeave
• onPlayerModInfo
• onPlayerMute
• onPlayerNetworkStatus
• onPlayerPickupHit
• onPlayerPickupLeave
• onPlayerPickupUse
• onPlayerPrivateMessage
• onPlayerProjectileCreation
• onPlayerQuit
• onPlayerScreenShot
• onPlayerSpawn
• onPlayerStealthKill
• onPlayerTarget
• onPlayerTeamChange
• onPlayerTeleport
• onPlayerTriggerEventThreshold
• onPlayerTriggerInvalidEvent
• onPlayerUnmute
• onPlayerVehicleEnter
• onPlayerVehicleExit
• onPlayerVoiceStart
• onPlayerVoiceStop
• onPlayerWasted
• onPlayerWeaponFire
• onPlayerWeaponReload
• onPlayerWeaponSwitch

Player Functions

• countPlayersInTeam
• forcePlayerMap
• getControlState
• getPlayerBlurLevel
• getPlayerFromName
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerScriptDebugLevel
• getPlayerSerial
• getPlayerTeam
• getPlayerWantedLevel
• getPlayersInTeam
• givePlayerMoney
• isPlayerMapForced
• isPlayerNametagShowing
• isVoiceEnabled
• setControlState
• setPlayerBlurLevel
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• takePlayerMoney
• getLocalPlayer
• getPlayerHudComponentProperty
• getPlayerMapBoundingBox
• getPlayerMapOpacity
• isPlayerCrosshairVisible
• isPlayerHudComponentVisible
• isPlayerMapVisible
• resetBlurLevel
• resetPlayerHudComponentProperty
• setPlayerHudComponentProperty
• getAlivePlayers
• getDeadPlayers
• getPlayerAnnounceValue
• getPlayerACInfo
• getPlayerCount
• getPlayerIP
• getPlayerIdleTime
• getPlayerVersion
• getRandomPlayer
• isPlayerMuted
• redirectPlayer
• resendPlayerModInfo
• resendPlayerACInfo
• setPlayerAnnounceValue
• setPlayerMuted
• setPlayerName
• setPlayerScriptDebugLevel
• setPlayerTeam
• setPlayerVoiceBroadcastTo
• setPlayerWantedLevel
• setPlayerVoiceIgnoreFrom
• spawnPlayer
• takePlayerScreenShot

Reference

• Scripting Events