lock: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (parameter should not have same name as command)
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(62 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Lock vehicle (disable mounting / dismounting) for player. Similar to [[setVehicleLock]] when number is used as param. |= Description
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| vehicleName '''lock''' locked|= Syntax
|game6= tkoh
|version6= 1.00


|p1= vehicleName: [[Object]] |= Parameter 1
|game7= arma3
|p2= locked: [[Boolean]] - [[true]] - lock; [[false]] - unlock|= Parameter 2
|version7= 0.50


| [[Nothing]] |= Return value
|arg= local


| s2=vehicleName '''lock''' lockstate|= Syntax
|eff= global


|p21= vehicleName: [[Object]] |= Parameter 1
|gr1= Object Manipulation
|p22= lockstate: [[Number]] - 0 - Unlocked; 1 - Default; 2 - Locked; 3 - Locked for player; |= Parameter 2


| r2=[[Nothing]] |= Return value
|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.}}
|x1= <code>_jeepOne [[lock]] [[true]];</code> |= Example 1
|x2= <code>heli [[lock]] [[true]];
[[locked]] heli; //2
heli [[lock]] [[false]];
[[locked]] heli; //0
heli [[lock]] 1;
[[locked]] heli; //1</code> |= Example 2
____________________________________________________________________________________________


| [[locked]], [[setVehicleLock]] |= See also
|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>


<h3 style="display:none">Notes</h3>
|x2= <sqf>
<dl class="command_description">
heli lock true;
<!-- Note Section BEGIN -->
locked heli; // 2
<dd class="notedate">Posted on January 9, 2010 - 22:50
<dt class="note">'''[[User:Tankbuster|Tankbuster]]'''<dd class="note">Lock prevents AI persons mounting or dismounting vehicles when ordered to do so and players are prevented from doing both too, but AI will dismount when a vehicle is damaged.


<dd class="notedate">Posted on September 22, 2010
heli lock false;
<dt class="note">'''[[User:Grimm|Grimm]]'''<dd class="note">If an AI group (eg Mechanized Infantry) has its vehicule 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.
locked heli; // 0


<dd class="notedate">Posted on April 2, 2013 - 12:55
heli lock 1;
<dt class="note">'''[[User:Druid|Druid]]'''<dd class="note">From Arma 3 version 0.50 can be used [[Number]] as lock parameter :<br/>
locked heli; // 1
0 - Unlocked<br/>
</sqf>
1 - Default<br/>
2 - Locked<br/>
3 - Locked for player


<!-- Note Section END -->
|seealso= [[locked]] [[setVehicleLock]] [[lockDriver]] [[lockCargo]] [[lockTurret]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|LOCK]]
|user= Tankbuster
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|timestamp= 20100109224800
[[Category:Scripting Commands OFP 1.96|LOCK]]
|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.
[[Category:Scripting Commands OFP 1.46|LOCK]]
}}
[[Category:Scripting Commands ArmA|LOCK]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= cali
<dd class="notedate">Posted on March 4, 2015 - 15:58 (UTC)</dd>
|timestamp= 20100922045600
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|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.
<dd class="note">
}}
1 - is DEFAULT lock for vehicle placed in editor. Player that is not the leader in a group of AIs will not be able to enter this vehicle.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"