Squirrel/Server/Functions/Vehicles/Locked
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|Vehicle.Locked}} This ''Vehicle'' class member returns whether the vehicle's doors are locked or locks/unlocks the doors. == Syntax == You can either return or…') |
|||
| Line 14: | Line 14: | ||
== Example 1. Returning == | == Example 1. Returning == | ||
| − | |||
| − | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
| + | { | ||
| + | if ( szCommand == "lock" ) | ||
| + | { | ||
| + | if ( pPlayer.Vehicle ) MessagePlayer( "Your lock state is currently set to " + pPlayer.Vehicle.Locked, pPlayer ); | ||
| + | } | ||
| + | |||
| + | return 1; | ||
| + | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
| − | + | 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 == | == Example 2. Setting == | ||
| − | |||
| − | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
| − | + | function onPlayerCommand( pPlayer, szCommand, szText ) | |
| + | { | ||
| + | if ( szCommand == "lock2" ) | ||
| + | { | ||
| + | if ( pPlayer.Vehicle ) pPlayer.Vehicle.Locked = true; | ||
| + | } | ||
| + | |||
| + | 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}} | ||
Revision as of 17:10, 29 September 2010
This Vehicle class member returns whether the vehicle's doors are locked or locks/unlocks the doors.
Syntax
You can either return or set a new value using this member:
Arguments
- locked - A boolean representing whether the vehicles doors should be locled (true) or unlocked (false)
Example 1. Returning
Notes
The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.
Example 2. Setting
Notes
The event onPlayerCommand was used in this example. More info about this in the corresponding page.
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
