Squirrel/Server/Functions/Messages/Message

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
m (Updated the example)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
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
+
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 ==
 
== Syntax ==
  
−
''Message'' can take 2 differant lists of parameters. These are:
+
''Message'' can take 2 different lists of parameters. These are:
  
−
<code>bool Message( string text, int r = 50, int g = 205, b = 50 )</code>
+
<code>bool Message( string text, int r, int g, int b )</code>
 
<code>bool Message( string text, Colour col )</code>
 
<code>bool Message( string text, Colour col )</code>
  
 
== Arguments ==
 
== Arguments ==
  
−
* '''text''' - This is the message to send to the player
+
* '''text''' - This is the message to send to players
−
* '''r''' - The ammount of Red to be in the colour
+
* '''r''' - The amount of Red to be in the colour
−
* '''g''' - The ammount of Green to be in the colour
+
* '''g''' - The amount of Green to be in the colour
−
* '''b''' - The ammount of Blue to be in the colour
+
* '''b''' - The amount of Blue to be in the colour
−
* '''col''' - A colour class. Good for defining your own colours at script start.
+
* '''col''' - A colour object. Good for defining your own colours at script start
  
 
== Example ==
 
== Example ==
Line 24: Line 24:
 
Col_Blue <- Colour( 0, 0, 255 );
 
Col_Blue <- Colour( 0, 0, 255 );
  
−
function OnPlayerCommand( id, cmd, text )
+
function onPlayerCommand( plr, cmd, text )
 
{
 
{
 
     if ( cmd == "test" )
 
     if ( cmd == "test" )
Line 38: Line 38:
 
=== Notes ===
 
=== Notes ===
  
−
The call [[Squirrel/Events/Player/OnPlayerCommand|OnPlayerCommand]] was used in in this example. More info about this in the corresponding page.
+
The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about this in the corresponding page.
  
 
== Related Functions ==
 
== Related Functions ==
  
−
{{Squirrel/Functions/Misc}}
+
{{Squirrel/Server/Functions/Messages}}

Revision as of 11:29, 9 September 2009

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 2 different lists of parameters. These are: 

  1. bool Message( string text, int r, int g, int b )
  1. 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
  • g - The amount of Green to be in the colour
  • b - The amount of Blue to be in the colour
  • col - A colour object. Good for defining your own colours at script start

Example

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

  1.  
  2. Col_Blue <- Colour( 0, 0, 255 );
  3.  
  4. function onPlayerCommand( plr, cmd, text )
  5. {
  6.      if ( cmd == "test" )
  7.      {
  8.           Message( "Testing..." );
  9.           Message( "Red!", 255, 0, 0 ); 
  10.           Message( "Green!", 0, 255, 0 );
  11.           Message( "Blue!", Col_Blue );
  12.      }
  13. }
  14.  

Notes

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

Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Messages/Message&oldid=368"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox