Vehicle.RGBColour1

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns or sets a custom primary colour for the vehicle. Note that if Vehicle.Colour1 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.RGBColour1
  1. Vehicle.RGBColour1 = Colour col

Arguments

  • col - This is a pointer to the custom RGB colour object to be used as the vehicle's primary 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.RGBColour1, pPlayer );
  7. }
  8. return 1;
  9. }
  10.  

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.RGBColour1 = Colour( 255, 0, 0 );
  7. }
  8. return 1;
  9. }
  10.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox