Message

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function sends a chatbox 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 different lists of parameters. These are:

bool Message( string text, [ int r, int g, int b ] )

bool Message( string text, [ Colour col ] )

Arguments

• text - This is the message to send to players
• 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 message saying 'Testing... Red! Green! Blue!' when somebody types '/test'

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

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