onPlayerPrivateMessage | Multi Theft Auto: Wiki Skip to content

onPlayerPrivateMessage

Client-side

Server-side

Shared

This event is triggered when a player sends a private message with msg command.

Parameters

string fullMessage, player recipient, string content

fullMessage: a string representing the message along with the nickname

recipient: the player to whom the message is being sent.

content: a string representing the message content only. This parameter is available since 1.6.0-9.22430 version.

Source

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

Canceling

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

Code Examples

server

This example blocks players sending a PM to a player named "Bob".

function blockPM(fullMsg,r,msg)
  if (getPlayerName(r) == "Bob") then -- If they sent a PM to "Bob"
    cancelEvent() -- Then cancel it
    outputChatBox("Bob is not accepting PM's at this time.",source,255,0,0) -- And output it was cancelled.
  end
end
addEventHandler("onPlayerPrivateMessage",root,blockPM)

See Also

Player Events

Player Functions

Reference

Scripting Events