Difference between revisions of "lock"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
 
(30 intermediate revisions by 17 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= local |= Effects in MP
+
|eff= global |Multiplayer Effects=
 +
 
 +
|gr1= Object Manipulation |GROUP1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Lock vehicle (disable mounting / dismounting) for player. |= 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Object#Vehicle|Vehicle]] '''lock''' Onff|= Syntax
+
| vehicleName [[lock]] locked |SYNTAX=
 +
 
 +
|p1= vehicleName: [[Object]] |PARAMETER1=
 +
 
 +
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock |PARAMETER2=
 +
 
 +
| [[Nothing]] |RETURNVALUE=
 +
 
 +
|s2= vehicleName [[lock]] lockstate &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v0.50'') |SYNTAX2=
 +
 
 +
|p21= vehicleName: [[Object]] |PARAMETER21=
  
|p1= OnOff: [[Boolean]]  
+
|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=
  
| [[Nothing]] |= Return value
+
|r2= [[Nothing]] |RETURNVALUE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>_jeepOne '''lock''' [[true]]</code> |= Example 1
+
|x1= <code>_jeepOne [[lock]] [[true]];</code> |EXAMPLE1=
 +
 
 +
|x2= <code>heli [[lock]] [[true]];
 +
[[locked]] heli; {{cc|2}}
 +
 
 +
heli [[lock]] [[false]];
 +
[[locked]] heli; {{cc|0}}
 +
 
 +
heli [[lock]] 1;
 +
[[locked]] heli; {{cc|1}}</code> |EXAMPLE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]|SEEALSO=
 
 
 
}}
 
}}
  
Line 31: Line 57:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 +
<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 still dismount when a vehicle is damaged.
 +
 +
<dd class="notedate">Posted on September 22, 2010
 +
<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.
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->
Line 36: Line 70:
  
 
<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.96|LOCK]]
+
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|LOCK]]
+
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|LOCK]]
+
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
+
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:20, 24 September 2020

Introduced with Operation Flashpoint version 1.001.00Arguments 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
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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

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