Squirrel/Server/Functions/Vehicles/Colour1

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Vehicle.Colour1}} 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…')
 
(Example 1. Returning the value)
Line 14: Line 14:
 
== Example 1. Returning the value ==
 
== Example 1. Returning the value ==
  
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
if ( szCommand == "col" )
 +
{
 +
if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle colour is " + pPlayer.Vehicle.Colour1, pPlayer );
 +
}
 +
 +
return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
Example notes and used functions here.
+
The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
  
 
== Example 2. Setting a new value ==
 
== Example 2. Setting a new value ==

Revision as of 15:54, 29 September 2010

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

This function needs an example. You can help us complete the wiki by writing one, or maybe even more :o
  1.  
  2. -- todo
  3.  

Notes

Example notes and used functions here.

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox