Difference between revisions of "lock"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(31 intermediate revisions by 20 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|LOCK]]
+
{{Command|Comments=
[[Category:Scripting Commands OFP 1.96|LOCK]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|LOCK]]
 
[[Category:Scripting Commands ArmA|LOCK]]
 
  
 +
| ofp |Game name=
  
<h2 style="color:#000066">'''''vehicle'' lock ''lock'''''</h2>
+
|1.00|Game version=
  
 +
|arg= local |Multiplayer Arguments=
  
'''Operand types:'''
+
|eff= global |Multiplayer Effects=
 +
____________________________________________________________________________________________
  
'''vehicle:''' [[Object]]
+
| 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=
 +
____________________________________________________________________________________________
  
'''lock:''' [[Boolean]]
+
| vehicleName [[lock]] locked |SYNTAX=
  
'''Type of returned value:'''
+
|p1= vehicleName: [[Object]] |PARAMETER1=
  
[[Nothing]]
+
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock |PARAMETER2=
  
'''Description:'''
+
| [[Nothing]] |RETURNVALUE=
  
'''Lock''' vehicle (disable mounting / dismounting) for player.
+
|s2= vehicleName [[lock]] lockstate &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v0.50'') |SYNTAX2=
  
 +
|p21= vehicleName: [[Object]] |PARAMETER21=
  
'''Example:'''
+
|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=
  
jeepOne '''lock''' [[true]]
+
|r2= [[Nothing]] |RETURNVALUE2=
 +
____________________________________________________________________________________________
 +
 
 +
|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=
 +
____________________________________________________________________________________________
 +
 
 +
| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]|SEEALSO=
 +
}}
 +
 
 +
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- 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 -->
 +
</dl>
 +
 
 +
<h3 style="display:none">Bottom Section</h3>
 +
[[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 ArmA|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]

Revision as of 00:21, 3 September 2019

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

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