Squirrel/Server/Functions/Vehicles/Colour1
From Liberty Unleashed Wiki
(Difference between revisions)
(→Example 1. Returning the value) |
(→Example 2. Setting a new value) |
||
| Line 32: | Line 32: | ||
== Example 2. Setting a new value == | == Example 2. Setting a new value == | ||
| − | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
| + | { | ||
| + | if ( szCommand == "col2" ) | ||
| + | { | ||
| + | if ( pPlayer.Vehicle ) pPlayer.Vehicle.Colour1 = 2; | ||
| + | } | ||
| + | |||
| + | return 1; | ||
| + | } | ||
| + | |||
</code> | </code> | ||
=== Notes === | === Notes === | ||
| − | + | The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about this in the corresponding page. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Vehicles}} | {{Squirrel/Server/Functions/Vehicles}} | ||
Latest revision as of 15:56, 29 September 2010
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.
[edit] Syntax
You can either return or set a new value using this member:
[edit] Arguments
- col - This is the new primary colour for the vehicle. Check out carcols.dat for colour IDs
[edit] Example 1. Returning the value
[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
[edit] Notes
The event onPlayerCommand was used in this example. More info about this in the corresponding page.
[edit] Related Functions
- CreateVehicle
- FindVehicle
- GetClosestVehicle
- GetVehicleCount
- GetVehicleHandlingData
- GetVehicleIDFromName
- GetVehicleName
- SetVehicleHandlingData
- Vehicle.Alpha
- Vehicle.Angle
- Vehicle.Colour1
- Vehicle.Colour2
- Vehicle.Driver
- Vehicle.EngineDamage
- Vehicle.Explode
- Vehicle.Fix
- Vehicle.GetAddon
- Vehicle.GetPassenger
- Vehicle.GetHandlingData
- Vehicle.GetWheelStatus
- Vehicle.Health
- Vehicle.ID
- Vehicle.IdleRespawnTime
- Vehicle.IdleTime
- Vehicle.LightState
- Vehicle.Locked
- Vehicle.Marker
- Vehicle.MarkerScale
- Vehicle.MarkerSprite
- Vehicle.Model
- Vehicle.OneTime
- Vehicle.PassengerCount
- Vehicle.Pos
- Vehicle.Remove
- Vehicle.Respawn
- Vehicle.RespawnTime
- Vehicle.RGBColour1
- Vehicle.RGBColour2
- Vehicle.SetHandlingData
- Vehicle.SetWheelStatus
- Vehicle.SpawnAngle
- Vehicle.SpawnPos
- Vehicle.SetAddon
- Vehicle.SetEngineState
- Vehicle.SetRadio
- Vehicle.Siren
- Vehicle.SirenLight
- Vehicle.TaxiLight
- Vehicle.Velocity
- Vehicle.VirtualWorld
- Vehicle.Wrecked
