Vehicle.Colour1

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 the primary colour of the vehicle. List of pre-defined colour IDs can be found from carcols.dat. Note that if Vehicle.RGBColour1 is used to define a custom colour, it will override this setting.

Syntax

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

  1. int Vehicle.Colour1
  1. Vehicle.Colour1 = int col

Arguments

  • col - This is the new primary colour for the vehicle. Check out carcols.dat for colour IDs

Example 1. Returning the value

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "col" )
  5. {
  6. if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle colour is " + pPlayer.Vehicle.Colour1, 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 == "col2" )
  5. {
  6. if ( pPlayer.Vehicle ) pPlayer.Vehicle.Colour1 = 2;
  7. }
  8. return 1;
  9. }
  10.  
  11.  

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