lockCargo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(order of params)
m (Some wiki formatting)
 
(47 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|version2= 1.50


|arg= local |= Arguments in MP
|game3= tkoh
|version3= 1.00


|eff= global |= Effects in MP
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Lock the all cargo positions of the vehicle. This command must be executed where vehicle is [[local]].|= Description
|arg= local
____________________________________________________________________________________________


| vehicle '''lockCargo''' lock  |= Syntax
|eff= global


|p1= vehicle: [[Object]]  |= PARAMETER1
|gr1= Object Manipulation


|p2= lock: [[Boolean]]   |= PARAMETER2
|descr= Lock all cargo positions of a vehicle or lock by index.
This command will remove user "get in" action (not get out) but will also stop player getting into vehicle via script commands (e.g [[moveInCargo]]) unlike [[lock]] command.


| [[Nothing]] |= RETURNVALUE
|s1= vehicle [[lockCargo]] lock


|s2= vehicle '''lockCargo''' [index, lock] |= Syntax
|p1= vehicle: [[Object]]


|p21= vehicle: [[Object]]   |= PARAMETER1
|p2= lock: [[Boolean]]


|p22= [index, lock]: [[Array]] |= PARAMETER2
|r1= [[Nothing]]


|p23= index: [[Number]] |= PARAMETER4
|s2= vehicle [[lockCargo]] [index, lock]
|p24= lock: [[Boolean]]   |= PARAMETER3


|r2= [[Nothing]] |= RETURNVALUE
|p21= vehicle: [[Object]]


|p22= index: [[Number]]


|x1= <code>vehicleName [[lockCargo]] [[true]];</code>|= EXAMPLE1
|p23= lock: [[Boolean]]


|x2= <code>vehicleName [[lockCargo]] [0, [[true]]];</code>|= EXAMPLE2
|r2= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>vehicleName lockCargo true;</sqf>


| [[lockedCargo]], [[lockDriver]], [[lockTurret]]  |= SEEALSO
|x2= <sqf>vehicleName lockCargo [0, true];</sqf>


| |= MPBEHAVIOUR
|seealso= [[lock]] [[setVehicleLock]] [[lockDriver]] [[lockedCargo]] [[lockTurret]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:45, 4 September 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Lock all cargo positions of a vehicle or lock by index. This command will remove user "get in" action (not get out) but will also stop player getting into vehicle via script commands (e.g moveInCargo) unlike lock command.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle lockCargo lock
Parameters:
vehicle: Object
lock: Boolean
Return Value:
Nothing

Alternative Syntax

Syntax:
vehicle lockCargo [index, lock]
Parameters:
vehicle: Object
index: Number
lock: Boolean
Return Value:
Nothing

Examples

Example 1:
vehicleName lockCargo true;
Example 2:
vehicleName lockCargo [0, true];

Additional Information

See also:
lock setVehicleLock lockDriver lockedCargo 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
Retrieved from "https://community.bistudio.com/wiki?title=lockCargo&oldid=330374"