Squirrel/Server/Functions/Players/Colour

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Player.Colour}} This ''Player'' class member returns or sets the colour of the player. These colour IDs are the ones defined in your content.xml. == Syntax …')
 

Latest revision as of 18:30, 1 October 2010

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

This Player class member returns or sets the colour of the player. These colour IDs are the ones defined in your content.xml.

[edit] Syntax

You can either return or set a new value using this member: 

  1. int Player.Colour
  1. Player.Colour = int col

[edit] Arguments

  • col - This is the new colour for the player. Check out content.xml for colour IDs

[edit] Example 1. Returning the value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "col" )
  5. 	{
  6. 		MessagePlayer( "Your player colour is " + pPlayer.Colour, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

[edit] Example 2. Setting a new value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "col2" )
  5. 	{
  6. 		pPlayer.Colour = 2;
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  
  12.  

[edit] Notes

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

[edit] Related Functions

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

Variants
Actions
Navigation
scripting
Toolbox