OnPlayerPM: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
this function allows you to send a private Message ( PM ) to a player.
== Syntax ==
== Syntax ==


Line 5: Line 7:
== Parameters ==
== Parameters ==


* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that uses command.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that sends the message.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''playerTo''' - The player to send the message.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''playerTo''' - The player to send the message.
* ''string'' '''text''' - this is the message to send.
* ''string'' '''text''' - this is the message to send.
Line 14: Line 16:
function onPlayerPM( player, playerTo, text )
function onPlayerPM( player, playerTo, text )
{
{
PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
if ( text )
{
PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
PrivMessage( player, "PM: ["+text+"] was sent to "+ playerTo );
}
else PrivMessage( player, "SYNTAX: /msg [player's ID] [text]" );
return 0;
}
}
</source>
</source>
Line 20: Line 28:
=== Notes ===
=== Notes ===


The function [[PrivMessage]] and call [[onPlayerPM]] were used in this example. More info about them in the corresponding pages.
The function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerPM]] were used in this example. More info about them in the corresponding pages.


== Related Events ==
== Related Functions ==


{{Scripting/Squirrel/Events/Player_Events}}
{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

Latest revision as of 22:15, 30 January 2017

this function allows you to send a private Message ( PM ) to a player.

Syntax

function onPlayerPM( player, playerTo, text )

Parameters

  • Player player - The player that sends the message.
  • Player playerTo - The player to send the message.
  • string text - this is the message to send.

Example

function onPlayerPM( player, playerTo, text )
{
	if ( text )
	{
		PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
		PrivMessage( player, "PM: ["+text+"] was sent to "+ playerTo );
	}
	else PrivMessage( player, "SYNTAX: /msg [player's ID] [text]" );
return 0;
}

Notes

The function PrivMessage and call onPlayerPM were used in this example. More info about them in the corresponding pages.

Related Functions