OnClientChatMessage

From Multi Theft Auto: Wiki
Revision as of 09:30, 16 February 2021 by DREFTHUN (talk | contribs) (Added messageType parameter based on PR https://github.com/multitheftauto/mtasa-blue/pull/1020)
Jump to navigation Jump to search

This event is triggered when any text is output to chatbox, including MTA's hardcoded messages.

Parameters

string text, int r, int g, int b, int messageType
  • text: The text that was output to chatbox
  • r: The amount of red in the color of the text.
  • g: The amount of green in the color of the text.
  • b: The amount of blue in the color of the text.
  • messageType: an int value representing the message type:
    • 0: normal message
    • 1: action message (/team)
    • 2: team message
    • 3: private message (/msg)
    • 4: hardcoded message

Source

The source of this event is either a player element or the root element.

Cancel effect

AS OF 1.3.2 If this event is canceled, the game's chat system won't deliver the posts. You may use outputChatBox to send the messages then.

Example

This example doesn't output anything to chatbox if it consists only of numbers

function onClientChatMessageHandler(text)
	if string.match(text,"%d+") --[[string.match searches for pattern "%d+", means decimals]] == text then -- if string.match and text itself are the same
		cancelEvent() -- don't output it
	end
end
addEventHandler("onClientChatMessage", getRootElement(), onClientChatMessageHandler)

See Also

Client other events


Client event functions