OnPlayerChat: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for server events)
 
(31 intermediate revisions by 19 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server event}}
{{Server event}}
This event is triggered when a player chats inside the chat box.
This event is triggered when a player chats inside the chatbox.


==Parameters==
==Parameters==
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''message''': A string representing the message typed into the chat.
*'''message''': a [[string]] representing the message typed into the chat.
*'''messageType''': An integer value representing the message type:
*'''messageType''': an [[int]] value representing the message type:
**'''0''': normal message
{{Message Types}}
**'''1''': action message (/me)
**'''2''': team message


==Source==
==Source==
Line 19: Line 17:
==Cancel effect==
==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.
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.
==Examples==
<section name="Example 1" class="server" show="true">
This example limits receiving of chat messages to area around the player who sent the message, also blocking action and team text.


==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">
<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 -- define our chat radius
local chatRadius = 20 --units
 
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


-- define a handler that will distribute the message to all nearby players
local playerName = getPlayerName(source)
function sendMessageToNearbyPlayers( message, messageType )
local playerX, playerY, playerZ = getElementPosition(source) -- get position of player who sent the message
    -- we will only send normal chat messages, action and team types will be ignored
local playerInterior = getElementInterior(source) -- get interior of same player
    if messageType == 0 then
local playerDimension = getElementDimension(source) -- dimension as well
        -- get the chatting player's position
local nearbyPlayers = getElementsWithinRange(playerX, playerY, playerZ, chatRadius, "player", playerInterior, playerDimension) -- get nearby players within given radius
        local posX, posY, posZ = getElementPosition( source )
local messageToOutput = playerName..": "..messageText
          
 
        -- create a sphere of the specified radius in that position
outputChatBox(messageToOutput, nearbyPlayers, 255, 255, 255, true) -- output message to them
        local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
cancelEvent() -- block the original message by cancelling this event
        -- get a table all player elements inside it
end
        local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
addEventHandler("onPlayerChat", root, onPlayerChatSendMessageToNearbyPlayers)
        -- and destroy the sphere, since we're done with it
</syntaxhighlight>
        destroyElement( chatSphere )
</section>
       
 
        -- deliver the message to each player in that table
<section name="Example 2" class="server" show="true">
        for index, nearbyPlayer in ipairs( nearbyPlayers ) do
This example implements colored player names in chat.
            outputChatBox( message, nearbyPlayer )
 
        end
<syntaxhighlight lang="lua">
    end
--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
end
-- attach our new chat handler to onPlayerChat
addEventHandler("onPlayerChat", root, playerChat)
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )
</syntaxhighlight>
</section>
 


-- define another handler function that cancels the event so that the message won't be delivered through the
<section name="Example 3" class="server" show="true">
function blockChatMessage()
This is a script that kills any player that says 'kill'.
     cancelEvent()
 
<syntaxhighlight lang="lua">
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
end
-- attach it as a handler to onPlayerChat
addEventHandler("onPlayerChat", root, onChat)
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )
</syntaxhighlight>
</syntaxhighlight>
</section>


{{See also/Server event|Player events}}
{{See also/Server event|Player events}}
[[ru:onPlayerChat]]

Latest revision as of 16:02, 3 May 2024

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

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

Cancel effect

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.

Examples

Click to collapse [-]
Example 1

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)
Click to collapse [-]
Example 2

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)


Click to collapse [-]
Example 3

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


Event functions

Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerChat?oldid=79288"