Difference between revisions of "lock"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<!-- Note Section [A-Z]+ --> " to "")
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |= Game name
+
| ofp
  
|1.00|= Game version
+
|1.00
  
|arg= local |= Arguments in MP
+
|arg= local
  
|eff= global |= Effects in MP
+
|eff= global
____________________________________________________________________________________________
 
  
| Lock vehicle (disable mounting / dismounting) for player. Similar to [[setVehicleLock]] when number is used as param. This command will remove user get in/get out actions but will not stop player getting into or out of vehicle via script commands|DESCRIPTION=
+
|gr1= Object Manipulation
____________________________________________________________________________________________
 
  
| vehicleName '''lock''' locked|SYNTAX=
+
| 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.}}
  
|p1= vehicleName: [[Object]] |PARAMETER1=
+
| vehicleName [[lock]] locked
|p2= locked: [[Boolean]] - [[true]] - lock; [[false]] - unlock|PARAMETER2=
 
  
| [[Nothing]] |RETURNVALUE=
+
|p1= vehicleName: [[Object]]
  
| s2=vehicleName '''lock''' lockstate|SYNTAX=
+
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock
  
|p21= vehicleName: [[Object]] |PARAMETER1=
+
| [[Nothing]]
|p22= lockstate: [[Number]] - 0 - Unlocked; 1 - Default; 2 - Locked; 3 - Locked for player; |PARAMETER2=
 
  
| r2=[[Nothing]] |RETURNVALUE=
+
|s2= vehicleName [[lock]] lockstate {{Since|arma3|0.50|y}}
____________________________________________________________________________________________
+
 
 +
|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= <code>_jeepOne [[lock]] [[true]];</code> |EXAMPLE1=
+
|x1= <code>_jeepOne [[lock]] [[true]];</code>
 +
 
 
|x2= <code>heli [[lock]] [[true]];
 
|x2= <code>heli [[lock]] [[true]];
[[locked]] heli; //2
+
[[locked]] heli; {{cc|2}}
 +
 
 
heli [[lock]] [[false]];
 
heli [[lock]] [[false]];
[[locked]] heli; //0
+
[[locked]] heli; {{cc|0}}
 +
 
 
heli [[lock]] 1;
 
heli [[lock]] 1;
[[locked]] heli; //1</code> |EXAMPLE2=
+
[[locked]] heli; {{cc|1}}</code>
____________________________________________________________________________________________
 
 
 
| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]|SEEALSO=
 
  
 +
|seealso= [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
<dt><dt>
<dd class="notedate">Posted on January 9, 2010 - 22:50
+
<dd class="notedate">Posted on January 9, 2010 - 22:50</dd>
<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.
+
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
 
+
<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 still dismount when a vehicle is damaged.
<dd class="notedate">Posted on September 22, 2010
+
<dt><dt>
<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.
+
<dd class="notedate">Posted on September 22, 2010</dd>
 
+
<dt class="note">[[User:Grimm|Grimm]]</dt>
<dd class="notedate">Posted on April 2, 2013 - 12:55
+
<dd class="note">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.
<dt class="note">'''[[User:Druid|Druid]]'''<dd class="note">From Arma 3 version 0.50 can be used [[Number]] as lock parameter :<br/>
 
0 - Unlocked<br/>
 
1 - Default<br/>
 
2 - Locked<br/>
 
3 - Locked for player
 
  
<!-- Note Section END -->
 
 
</dl>
 
</dl>
  
<h3 style="display:none">Bottom Section</h3>
+
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands|LOCK]]
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands OFP 1.96|LOCK]]
+
{{GameCategory|tkoh|Scripting Commands}}
[[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 -->
 
<dl class="command_description">
 
<dd class="notedate">Posted on March 4, 2015 - 15:58 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<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 01:33, 6 April 2021

Hover & click on the images for descriptions

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.

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 Since Arma 3 v0.50
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:
lockedsetVehicleLocklockDriverlockCargolockTurret
Groups:
Object Manipulation

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
Posted on January 9, 2010 - 22:50
Tankbuster
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.
Posted on September 22, 2010
Grimm
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.