lock: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(90 intermediate revisions by 20 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#L|COMREF]]
{{RV|type=command


<h2 style="color:#000066">'''''vehicle'' lock ''lock'''''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''vehicle:''' [[Object]]
|game4= arma2
|version4= 1.00


'''lock:''' [[Boolean]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|arg= local


'''Lock''' vehicle (disable mounting / dismounting) for player.
|eff= global


|gr1= Object Manipulation


'''Example:'''
|descr= Lock vehicle (disable mounting / dismounting) for player.
This command will remove user get in/get out actions but will not stop player getting into or out of vehicle via script commands (e.g [[moveInCargo]]).
{{Feature|informative|Alternative syntax is similar to [[setVehicleLock]] but with numbers.}}


jeepOne '''lock''' [[true]]
|s1= vehicleName [[lock]] locked
 
|p1= vehicleName: [[Object]]
 
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock
 
|r1= [[Nothing]]
 
|s2= vehicleName [[lock]] lockstate
 
|s2since= arma3 0.50
 
|p21= vehicleName: [[Object]]
 
|p22= lockstate: [[Number]] - can be one of the following:<br>
0 - Unlocked<br>
1 - Default (player subordinate cannot enter until his leader says so)<br>
2 - Locked<br>
3 - Locked for player
 
|r2= [[Nothing]]
 
|x1= <sqf>_jeepOne lock true;</sqf>
 
|x2= <sqf>
heli lock true;
locked heli; // 2
 
heli lock false;
locked heli; // 0
 
heli lock 1;
locked heli; // 1
</sqf>
 
|seealso= [[locked]] [[setVehicleLock]] [[lockDriver]] [[lockCargo]] [[lockTurret]]
}}
 
{{Note
|user= Tankbuster
|timestamp= 20100109224800
|text= Lock prevents AI persons mounting or dismounting vehicles when ordered to do so and players are prevented from doing both too, but AI will still dismount when a vehicle is damaged.
}}
 
{{Note
|user= cali
|timestamp= 20100922045600
|text= If an AI group (e.g Mechanized Infantry) has its vehicle locked with its crew in it, it will mount or dismount it anyway. But a player in this group won't be able to enter the vehicle.
}}

Latest revision as of 18:11, 15 March 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Lock vehicle (disable mounting / dismounting) for player. This command will remove user get in/get out actions but will not stop player getting into or out of vehicle via script commands (e.g moveInCargo).
ⓘ
Alternative syntax is similar to setVehicleLock but with numbers.
Groups:
Object Manipulation

Syntax

Syntax:
vehicleName lock locked
Parameters:
vehicleName: Object
locked: Boolean - true to lock, false to unlock
Return Value:
Nothing

Alternative Syntax

Syntax:
vehicleName lock lockstate
Parameters:
vehicleName: Object
lockstate: Number - can be one of the following:
0 - Unlocked
1 - Default (player subordinate cannot enter until his leader says so)
2 - Locked
3 - Locked for player
Return Value:
Nothing

Examples

Example 1:
_jeepOne lock true;
Example 2:
heli lock true; locked heli; // 2 heli lock false; locked heli; // 0 heli lock 1; locked heli; // 1

Additional Information

See also:
locked setVehicleLock lockDriver lockCargo lockTurret

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Tankbuster - c
Posted on Jan 09, 2010 - 22:48 (UTC)
Lock prevents AI persons mounting or dismounting vehicles when ordered to do so and players are prevented from doing both too, but AI will still dismount when a vehicle is damaged.
cali - c
Posted on Sep 22, 2010 - 04:56 (UTC)
If an AI group (e.g Mechanized Infantry) has its vehicle locked with its crew in it, it will mount or dismount it anyway. But a player in this group won't be able to enter the vehicle.
Retrieved from "https://community.bistudio.com/wiki?title=lock&oldid=353298"