Vehicle.RGBColour2

From Liberty Unleashed Wiki
Revision as of 17:33, 29 September 2010 by Force (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns or sets a custom secondary colour for the vehicle. Note that if Vehicle.Colour2 is used to change the colour, it will override this setting.

Syntax

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

  1. Colour Vehicle.RGBColour2
  1. Vehicle.RGBColour2 = Colour col

Arguments

  • col - This is a pointer to the custom RGB colour object to be used as the vehicle's secondary colour

Example 1. Returning the value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "rgb" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) MessagePlayer( "Vehicle RGB colour is " + pPlayer.Vehicle.RGBColour2, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

Notes

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

Example 2. Setting a new value 

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

Notes

The event onPlayerCommand was used 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/Vehicles/RGBColour2&oldid=1779"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox