lock: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|arg= local
|arg= local
Line 11: Line 28:
|gr1= Object Manipulation
|gr1= Object Manipulation


| Lock vehicle (disable mounting / dismounting) for player.
|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]]).
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]]).
{{Informative | Alternative syntax is similar to [[setVehicleLock]] but with numbers.}}
{{Feature|informative|Alternative syntax is similar to [[setVehicleLock]] but with numbers.}}


| vehicleName [[lock]] locked
|s1= vehicleName [[lock]] locked


|p1= vehicleName: [[Object]]
|p1= vehicleName: [[Object]]
Line 21: Line 38:
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock
|p2= locked: [[Boolean]] - [[true]] to lock, [[false]] to unlock


| [[Nothing]]
|r1= [[Nothing]]
 
|s2= vehicleName [[lock]] lockstate


|s2= vehicleName [[lock]] lockstate {{Since|arma3|0.50|y}}
|s2since= arma3 0.50


|p21= vehicleName: [[Object]] |PARAMETER21=
|p21= vehicleName: [[Object]]


|p22= lockstate: [[Number]] - Can be one of the following:<br>
|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]]
|r2= [[Nothing]]
 
|x1= <code>_jeepOne [[lock]] [[true]];</code>


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


heli [[lock]] [[false]];
heli lock false;
[[locked]] heli; {{cc|0}}
locked heli; // 0


heli [[lock]] 1;
heli lock 1;
[[locked]] heli; {{cc|1}}</code>
locked heli; // 1
</sqf>


| [[locked]], [[setVehicleLock]], [[lockDriver]], [[lockCargo]], [[lockTurret]]
|seealso= [[locked]] [[setVehicleLock]] [[lockDriver]] [[lockCargo]] [[lockTurret]]
}}
}}


<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Tankbuster
|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>
 
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 18: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.