lock: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(53 intermediate revisions by 2 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 |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= global |Multiplayer Effects=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Lock vehicle (disable mounting / dismounting) for player.
|game5= arma2oa
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>
|version5= 1.50
{{Informative | Alternative syntax is similar to [[setVehicleLock]] but with numbers.}} |DESCRIPTION=
____________________________________________________________________________________________


| vehicleName [[lock]] locked |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= vehicleName: [[Object]] |PARAMETER1=
|game7= arma3
|version7= 0.50


|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock |PARAMETER2=
|arg= local


| [[Nothing]] |RETURNVALUE=
|eff= global


|s2= vehicleName [[lock]] lockstate &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since {{arma3}} v0.50'') |SYNTAX2=
|gr1= Object Manipulation


|p21= vehicleName: [[Object]] |PARAMETER21=
|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.}}


|p22= lockstate: [[Number]] - Can be one of the following:<br>
|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>
0 - Unlocked<br>
1 - Default (player subordinate cannot enter until his leader says so)<br>
1 - Default (player subordinate cannot enter until his leader says so)<br>
2 - Locked<br>
2 - Locked<br>
3 - Locked for player |PARAMETER22=
3 - Locked for player


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>_jeepOne [[lock]] [[true]];</code> |EXAMPLE1=


|x2= <code>heli [[lock]] [[true]];
|x1= <sqf>_jeepOne lock true;</sqf>
[[locked]] heli; {{cc|2}}


heli [[lock]] [[false]];
|x2= <sqf>
[[locked]] heli; {{cc|0}}
heli lock true;
locked heli; // 2


heli [[lock]] 1;
heli lock false;
[[locked]] heli; {{cc|1}}</code> |EXAMPLE2=
locked heli; // 0
____________________________________________________________________________________________


| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]|SEEALSO=
heli lock 1;
locked heli; // 1
</sqf>
 
|seealso= [[locked]] [[setVehicleLock]] [[lockDriver]] [[lockCargo]] [[lockTurret]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Tankbuster
<!-- Note Section BEGIN -->
|timestamp= 20100109224800
|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.
}}


<dd class="notedate">Posted on January 9, 2010 - 22:50
{{Note
<dt class="note">[[User:Tankbuster|Tankbuster]]
|user= cali
<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.
|timestamp= 20100922045600
 
|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="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}}}}]]

Latest revision as of 19:11, 15 March 2024

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.