Squirrel/Server/Functions/Messages/Message

Revision as of 14:04, 8 March 2009

This function sends a message to all the players in the game. It can be customised to your own colour if needed. Defaults to Green

Syntax

Message can take 2 differant lists of parameters. These are:

bool Message( string text, int r = 50, int g = 205, b = 50 )

bool Message( string text, Colour col )

Arguments

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

Example

This will send a message saying 'Testing... Red! Green! Blue!' when somebody types '/test'

 
Col_Blue <- Colour( 0, 0, 255 );
 
function OnPlayerCommand( id, cmd, text )
{
     if ( cmd == "test" )
     {
          Message( "Testing..." );
          Message( "Red!", 255, 0, 0 ); 
          Message( "Green!", 0, 255, 0 );
          Message( "Blue!", Col_Blue );
     }
}
 

Notes

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

Related Functions

Template:Squirrel/Functions/Misc