Difference between revisions of "lock"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (parameter should not have same name as command)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofp |= Game name
+
| ofp |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
  
|arg= local |= Arguments in MP
+
|arg= local |Multiplayer Arguments=
  
|eff= global |= Effects in MP
+
|eff= global |Multiplayer Effects=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Lock vehicle (disable mounting / dismounting) for player. Similar to [[setVehicleLock]] when number is used as param. |= 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]]).<br><br>
 +
{{Informative | Alternative syntax is similar to [[setVehicleLock]] but with numbers.}} |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| vehicleName '''lock''' locked|= Syntax
+
| vehicleName [[lock]] locked |SYNTAX=
  
|p1= vehicleName: [[Object]] |= Parameter 1
+
|p1= vehicleName: [[Object]] |PARAMETER1=
|p2= locked: [[Boolean]] - [[true]] - lock; [[false]] - unlock|= Parameter 2
 
  
| [[Nothing]] |= Return value
+
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock |PARAMETER2=
  
| s2=vehicleName '''lock''' lockstate|= Syntax
+
| [[Nothing]] |RETURNVALUE=
  
|p21= vehicleName: [[Object]] |= Parameter 1
+
|s2= vehicleName [[lock]] lockstate &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v0.50'') |SYNTAX2=
|p22= lockstate: [[Number]] - 0 - Unlocked; 1 - Default; 2 - Locked; 3 - Locked for player; |= Parameter 2
 
  
| r2=[[Nothing]] |= Return value
+
|p21= vehicleName: [[Object]] |PARAMETER21=
 +
 
 +
|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 |PARAMETER22=
 +
 
 +
|r2= [[Nothing]] |RETURNVALUE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>_jeepOne [[lock]] [[true]];</code> |= Example 1
+
|x1= <code>_jeepOne [[lock]] [[true]];</code> |EXAMPLE1=
 +
 
 
|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> |= Example 2
+
[[locked]] heli; {{cc|1}}</code> |EXAMPLE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[locked]], [[setVehicleLock]] |= See also
+
| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]|SEEALSO=
 
 
 
}}
 
}}
  
Line 45: Line 55:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 
<dd class="notedate">Posted on January 9, 2010 - 22:50
 
<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.
+
<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 still dismount when a vehicle is damaged.
  
 
<dd class="notedate">Posted on September 22, 2010
 
<dd class="notedate">Posted on September 22, 2010
<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.
+
<dt class="note">[[User:Grimm|Grimm]]
 
+
<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.
<dd class="notedate">Posted on April 2, 2013 - 12:55
 
<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 -->
 
<!-- Note Section END -->
Line 62: Line 68:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|LOCK]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|LOCK]]
+
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[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 ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
+
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
+
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
<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 23:21, 2 September 2019

Introduced with Operation Flashpoint version1.00
  Arguments of this scripting command have to be local to the client the command is executed onEffects of this scripting command are broadcasted over the network and happen on every computer in the network

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

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

Multiplayer:
-
See also:
lockedsetVehicleLocklockDriverlockCargolockTurret

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

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.

Bottom Section