Scripting/Squirrel/Functions/Vehicles/IsLocked

From VC-MP Wiki

Jump to: navigation, search

This instance variable returns whether the vehicle doors have been locked, or locks/unlocks them.

Syntax

bool vehicle.IsLocked

vehicle.IsLocked = bool bLocked

Example 1. Setting

Enter a vehicle. Then type '!lock'.

function onPlayerChat( player, text )
{
     if ( text == "!lock" )
     {
         if ( !player.Vehicle ) PrivMessage( "O c'mon! You must be in a vehicle, what else do you want close?", player );
         else {
             PrivMessage( "The vehicle was closed. How do you get now out?", player );
             player.Vehicle.IsLocked = true;
         }
     }
 
}

Example 2. Setting

Enter a vehicle. Then type '!unlock'.

function onPlayerChat( player, text )
{
     if ( text == "!unlock" )
     {
         if ( !player.Vehicle ) PrivMessage( "O c'mon! You must be in a vehicle, what else do you want close?", player );
         else {
             PrivMessage( "The vehicle was open. How do you get now out?", player );
             player.Vehicle.IsLocked = false;
         }
     }
 
}

Notes

The function PrivMessage and call onPlayerChat were used in in this example. More info about them in the corresponding pages.

Related Functions

Personal tools
squirrel scripting