setUnloadInCombat: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(a first attempt at rephrasing - have at it; also, in brief testing couldn't setup a scenario where a turret unit dismounted, but command seems to imply this is possible. maybe heli turrets (bench units)?)
No edit summary
 
(38 intermediate revisions by 5 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


|arg= local |=
|gr1= Unit Control
|eff= global |=
____________________________________________________________________________________________


| If 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. |= Description
|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
____________________________________________________________________________________________


| vehicle [[setUnloadInCombat]] [allowCargo, allowTurrets] |= Syntax
|s1= vehicle [[setUnloadInCombat]] [allowCargo, allowTurrets]


|p1= vehicle: [[Object]]|= Parameter 1
|p1= vehicle: [[Object]]


|p2= allowCargo: [[Boolean]]|= Parameter 2
|p2= allowCargo: [[Boolean]]


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


| Nothing |= Return value
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>vehicle [[setUnloadInCombat]] [true, false]</code> |= Example 1
|x1= <sqf>_veh setUnloadInCombat [true, false];</sqf>
____________________________________________________________________________________________
 
|  |= See also


|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

Arma 3 logo black.png1.36
LALocalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=setUnloadInCombat&oldid=336388"