setUnloadInCombat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Description strait from game, seems incorrect.)
 
No edit summary
 
(39 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.36


|1.36|= Game version
|arg= local
____________________________________________________________________________________________
|eff= global


| Check if cargo of this vehicle want to getout when in combat. Vehicle has to be local. |= Description
|gr1= Unit Control
____________________________________________________________________________________________


| vehicle [[setUnloadInCombat]] [allowCargo, allowTurrets] |= Syntax
|descr= Sets whether or not cargo or turret units ''should'' get out of vehicle when in combat. If '''true''', vehicle will stop and units will dismount. Vehicle must be local. The command resets last time unit had reacted to an enemy as well as forcing [[orderGetIn]] [[false]] if [[canUnloadInCombat]] is permitted by config


|p1= vehicle: [[Object]]|= Parameter 1
|s1= vehicle [[setUnloadInCombat]] [allowCargo, allowTurrets]


|p2= allowCargo: [[Boolean]]|= Parameter 2
|p1= vehicle: [[Object]]


|p3= allowTurrets: [[Boolean]]|= Parameter 3
|p2= allowCargo: [[Boolean]]


| Nothing |= Return value
|p3= allowTurrets: [[Boolean]]
____________________________________________________________________________________________


|x1= <code>vehicle [[setUnloadInCombat]] [true, false]</code> |= Example 1
|r1= [[Nothing]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>_veh setUnloadInCombat [true, false];</sqf>


|seealso= [[getUnloadInCombat]] [[canUnloadInCombat]] [[allowCrewInImmobile]] [[isAllowedCrewInImmobile]]
}}
}}
<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:Scripting Commands|FINDNEARESTENEMY]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 22:54, 31 December 2022

Hover & click on the images for description

Description

Description:
Sets whether or not cargo or turret units should get out of vehicle when in combat. If true, vehicle will stop and units will dismount. Vehicle must be local. The command resets last time unit had reacted to an enemy as well as forcing orderGetIn false if canUnloadInCombat is permitted by config
Groups:
Unit Control

Syntax

Syntax:
vehicle setUnloadInCombat [allowCargo, allowTurrets]
Parameters:
vehicle: Object
allowCargo: Boolean
allowTurrets: Boolean
Return Value:
Nothing

Examples

Example 1:
_veh setUnloadInCombat [true, false];

Additional Information

See also:
getUnloadInCombat canUnloadInCombat allowCrewInImmobile isAllowedCrewInImmobile

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