Vehicle.Locked

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

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:

  1. bool Vehicle.Locked
  1. Vehicle.Locked = bool locked

Arguments

  • locked - A boolean representing whether the vehicles doors should be locked (true) or unlocked (false)

Example 1. Returning

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "lock" )
  5. {
  6. if ( pPlayer.Vehicle ) MessagePlayer( "Your lock state is currently set to " + pPlayer.Vehicle.Locked, 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

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "lock2" )
  5. {
  6. if ( pPlayer.Vehicle ) pPlayer.Vehicle.Locked = true;
  7. }
  8. return 1;
  9. }
  10.  

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