OnPlayerChat

2011-10-08T21:34:56Z

John Michael: Cleaned up the second example, made it work as described.

__NOTOC__
{{Server event}}
This event is triggered when a player chats inside the chat box.

==Parameters==
<syntaxhighlight lang="lua">
string message, int messageType
</syntaxhighlight>

*'''message''': A string representing the message typed into the chat.
*'''messageType''': An integer value representing the message type:
**'''0''': normal message
**'''1''': action message (/me)
**'''2''': team message

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who sent the chatbox message.

==Cancel effect==
If this event is [[Event system#Canceling|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.

==Example==
This example limits receiving of chat messages to a spherical area around the player who sent the message, also blocking action and team text.
<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 --units

-- define a handler that will distribute the message to all nearby players
function sendMessageToNearbyPlayers( message, messageType )
-- we will only send normal chat messages, action and team types will be ignored
if messageType == 0 then
-- get the chatting player's position
local posX, posY, posZ = getElementPosition( source )

-- create a sphere of the specified radius in that position
local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
-- get a table all player elements inside it
local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
-- and destroy the sphere, since we're done with it
destroyElement( chatSphere )

-- deliver the message to each player in that table
for index, nearbyPlayer in ipairs( nearbyPlayers ) do
outputChatBox( message, nearbyPlayer )
end
end
end
-- attach our new chat handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )

-- define another handler function that cancels the event so that the message won't be delivered through the
function blockChatMessage()
cancelEvent()
end
-- attach it as a handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )
</syntaxhighlight>
This example sets random color to every player who joins.
<syntaxhighlight lang="lua">
-- sets colors when player join
function onJoin ()
local g_Red, g_Green, g_Blue = math.random (50, 255), math.random (50, 255), math.random (50, 255)
setPlayerNametagColor(source, g_Red, g_Green, g_Blue)
end
-- checks if player has sent a message
function onChat ( message, messageType )
if messageType == 0 then
cancelEvent()
local g_Red, g_Green, g_Blue = getPlayerNametagColor(source)
outputChatBox ( getPlayerName ( source ) .. ": #E0D0B0" .. message, root, g_Red, g_Green, g_Blue, true )
outputServerLog( "CHAT: " .. getPlayerName ( source ).. ": " .. message )
end
end
--root is a constant variable for getRootElement() - so these events will all be attatched to the root element.
addEventHandler ( "onPlayerJoin", root, onJoin)
addEventHandler ( "onPlayerChat", root, onChat )
</syntaxhighlight>

{{See also/Server event|Player events}}

Multi Theft Auto: Wiki - User contributions [en]

OnPlayerChat