OnPlayerPrivateMessage - Revision history

FileEX: Add content argument

2024-05-23T21:37:54Z

Add content argument

← Older revision		Revision as of 21:37, 23 May 2024
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 ~~to be sent.~~		*'''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 19:		Line 20:
	This example blocks players sending a PM to a player named "Bob".		This example blocks players sending a PM to a player named "Bob".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function blockPM(~~msg~~,r)		function blockPM(fullMsg,r,msg)
	if (getPlayerName(r) == "Bob") then -- If they sent a PM to "Bob"		if (getPlayerName(r) == "Bob") then -- If they sent a PM to "Bob"
	cancelEvent() -- Then cancel it		cancelEvent() -- Then cancel it

2020-11-04T09:01:21Z

← Older revision		Revision as of 09:01, 4 November 2020
Line 25:		Line 25:
	end		end
	end		end
	addEventHandler("onPlayerPrivateMessage",~~getRootElement()~~,blockPM)		addEventHandler("onPlayerPrivateMessage",root,blockPM)
	</syntaxhighlight>		</syntaxhighlight>

2018-09-27T03:02:24Z

← Older revision		Revision as of 03:02, 27 September 2018
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Player events}}
	~~===~~Player events~~===~~
	~~{{Player_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

	[[ru:onPlayerPrivateMessage]]		[[ru:onPlayerPrivateMessage]]

2018-09-27T02:16:17Z

← Older revision		Revision as of 02:16, 27 September 2018
Line 27:		Line 27:
	addEventHandler("onPlayerPrivateMessage",getRootElement(),blockPM)		addEventHandler("onPlayerPrivateMessage",getRootElement(),blockPM)
	</syntaxhighlight>		</syntaxhighlight>
	{{See ~~also/Server event\|~~Player events}}
			==See Also==
			===Player events===
			{{Player_events}}
			===Event functions===
			{{Event functions}}

	[[ru:onPlayerPrivateMessage]]		[[ru:onPlayerPrivateMessage]]

2018-04-02T21:49:56Z

Parameters

← Older revision		Revision as of 21:49, 2 April 2018
Line 7:		Line 7:
	string message, player recipient		string message, player recipient
	</syntaxhighlight>		</syntaxhighlight>
	*'''message''': A string representing the private message ~~typed~~.		*'''message''': a [[string]] representing the private message to be sent.
	*'''recipient''': ~~The~~ [[player]] to whom the message is being sent.		*'''recipient''': the [[player]] to whom the message is being sent.

	==Source==		==Source==

2017-12-04T18:07:43Z

← Older revision		Revision as of 18:07, 4 December 2017
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>
	{{See also/Server event\|Player events}}		{{See also/Server event\|Player events}}

			[[ru:onPlayerPrivateMessage]]

2013-06-02T00:02:53Z

Undo revision 36267 by MOJRM-511 (talk)

← Older revision		Revision as of 00:02, 2 June 2013
Line 17:		Line 17:

	==Example==		==Example==
	This example ~~send~~ to ~~players pm messages~~		This example blocks players sending a PM to a player named "Bob".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function blockPM(msg,r)		function blockPM(msg,r)
	if (getPlayerName(r) == "~~MOJRM-511~~") then -- If they sent a PM to "~~MOJRM-511~~"		if (getPlayerName(r) == "Bob") then -- If they sent a PM to "Bob"
	cancelEvent() -- Then cancel it		cancelEvent() -- Then cancel it
	outputChatBox("~~MOJRM-511~~ is not accepting PM's at this time.",source,255,0,0) -- And output it was cancelled.		outputChatBox("Bob is not accepting PM's at this time.",source,255,0,0) -- And output it was cancelled.
	end		end
	end		end

2013-06-01T23:18:52Z

Example

← Older revision		Revision as of 23:18, 1 June 2013
Line 17:		Line 17:

	==Example==		==Example==
	This example ~~blocks~~ players ~~sending a PM to a player named "Bob".~~		This example send to players pm messages
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function blockPM(msg,r)		function blockPM(msg,r)
	if (getPlayerName(r) == "~~Bob~~") then -- If they sent a PM to "~~Bob~~"		if (getPlayerName(r) == "MOJRM-511") then -- If they sent a PM to "MOJRM-511"
	cancelEvent() -- Then cancel it		cancelEvent() -- Then cancel it
	outputChatBox("~~Bob~~ is not accepting PM's at this time.",source,255,0,0) -- And output it was cancelled.		outputChatBox("MOJRM-511 is not accepting PM's at this time.",source,255,0,0) -- And output it was cancelled.
	end		end
	end		end

2010-08-16T01:19:06Z

Example

← Older revision		Revision as of 01:19, 16 August 2010
Line 17:		Line 17:

	==Example==		==Example==
			This example blocks players sending a PM to a player named "Bob".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~TODO~~		function blockPM(msg,r)
			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",getRootElement(),blockPM)
	</syntaxhighlight>		</syntaxhighlight>
	{{See also/Server event\|Player events}}		{{See also/Server event\|Player events}}
	~~[[Category:Needs_Example]]~~