Squirrel/Server/Functions/Vehicles/Siren
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|Vehicle.SirenLight}} This ''Vehicle'' class member returns whether the vehicle's siren light is enabled or enables/disables it. Note that this member is only val…') |
|||
| Line 1: | Line 1: | ||
| − | {{Squirrel/Title|Vehicle. | + | {{Squirrel/Title|Vehicle.Siren}} |
| − | This ''Vehicle'' class member returns whether the vehicle's siren | + | This ''Vehicle'' class member returns whether the vehicle's siren is enabled or enables/disables it. Note that this member is only valid for vehicles with a siren. |
== Syntax == | == Syntax == | ||
You can either return or set a new value using this member: | You can either return or set a new value using this member: | ||
| − | <code>bool Vehicle. | + | <code>bool Vehicle.Siren</code> |
| − | <code>Vehicle. | + | <code>Vehicle.Siren = bool enabled</code> |
== Arguments == | == Arguments == | ||
| − | * '''enabled''' - A boolean representing whether siren | + | * '''enabled''' - A boolean representing whether siren should be enabled (''true'') or disabled (''false'') |
== Example 1. Returning == | == Example 1. Returning == | ||
| Line 18: | Line 18: | ||
{ | { | ||
| − | if ( szCommand == " | + | if ( szCommand == "siren" ) |
{ | { | ||
| − | if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's siren | + | if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's siren is currently - " + pPlayer.Vehicle.Siren, pPlayer ); |
} | } | ||
| Line 36: | Line 36: | ||
function onPlayerCommand( pPlayer, szCommand, szText ) | function onPlayerCommand( pPlayer, szCommand, szText ) | ||
{ | { | ||
| − | if ( szCommand == " | + | if ( szCommand == "sirenon" ) |
{ | { | ||
| − | if ( pPlayer.Vehicle ) pPlayer.Vehicle. | + | if ( pPlayer.Vehicle ) pPlayer.Vehicle.Siren = true; |
} | } | ||
Latest revision as of 22:04, 12 September 2011
This Vehicle class member returns whether the vehicle's siren is enabled or enables/disables it. Note that this member is only valid for vehicles with a siren.
[edit] Syntax
You can either return or set a new value using this member:
[edit] Arguments
- enabled - A boolean representing whether siren should be enabled (true) or disabled (false)
[edit] Example 1. Returning
[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
[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
