OnPlayerPrivateMessage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with '__NOTOC__ {{Server event}} This event is triggered when a player sends a private message with ''msg'' command. ==Parameters== <syntaxhighlight lang="lua"> string message, player recipient </co…')
 
m (Add content argument)
 
(8 intermediate revisions by 7 users not shown)
Line 5: Line 5:
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string message, player recipient
string fullMessage, player recipient, string content
</syntaxhighlight>  
</syntaxhighlight>  
*'''message''': A string representing the private message typed.
*'''fullMessage''': a [[string]] representing the message along with the nickname
*'''recipient''': The [[player]] to whom the message is being sent.
*'''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==
==Source==
Line 17: Line 18:


==Example==  
==Example==  
This example blocks players sending a PM to a player named "Bob".
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TODO
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)
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Player events}}
{{See also/Server event|Player events}}
[[Category:Needs_Example]]
 
[[ru:onPlayerPrivateMessage]]

Latest revision as of 21:37, 23 May 2024

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

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

Cancel effect

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

Example

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


Event functions

Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerPrivateMessage?oldid=79384"