lock: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|arg= local |Multiplayer Arguments=
|arg= local


|eff= global |Multiplayer Effects=
|eff= global


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation
____________________________________________________________________________________________


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


| vehicleName [[lock]] locked |SYNTAX=
| vehicleName [[lock]] locked


|p1= vehicleName: [[Object]] |PARAMETER1=
|p1= vehicleName: [[Object]]


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


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


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


|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>
Line 34: Line 31:
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=
|x1= <code>_jeepOne [[lock]] [[true]];</code>


|x2= <code>heli [[lock]] [[true]];
|x2= <code>heli [[lock]] [[true]];
Line 48: Line 44:


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


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


<h3 style="display:none">Notes</h3>
<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</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<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="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</dd>
<dt class="note">[[User:Grimm|Grimm]]
<dt class="note">[[User:Grimm|Grimm]]</dt>
<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="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.


Line 69: Line 63:
</dl>
</dl>


<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]

Revision as of 00:54, 17 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Object Manipulation

Syntax

Syntax:
Syntax needed
Parameters:
vehicleName: Object
locked: Boolean - true to lock, false to unlock
Return Value:
Return value needed

Alternative Syntax

Syntax:
vehicleName lock lockstate Template:Since
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

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
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.