Squirrel/Server/Functions/Messages/MessagePlayer

Revision as of 01:57, 16 October 2010

This function sends a personal message to a player in the game. It can be customized to your own colour if needed.

Syntax

bool MessagePlayer( string text, Player plr, [ int r, int g, int b ] )

bool MessagePlayer( string text, Player plr, [ Colour col ] )

Arguments

• text - This is the message to send to the player
• plr - This is the pointer of the player
• r - The amount of Red to be in the colour. This argument is optional
• g - The amount of Green to be in the colour. This argument is optional
• b - The amount of Blue to be in the colour. This argument is optional
• col - A colour object. Good for defining your own colours at script start. This argument is optional

Example

This will send a personal message saying 'Testing PM...' when a player types '/testpm'

 
function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "testpm" )
     {
          MessagePlayer( "Testing PM...", player, 255, 0, 0 );
     }
}
 

Notes

The call onPlayerCommand was used in in this example. More info about this in the corresponding page.

Related Functions

• BigMessage
• ClearMessages
• Message
• MessageAllExcept
• MessagePlayer
• PagerMessage
• SendPlayerMessage
• SmallMessage