fleeing: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|gr1= Object Manipulation |GROUP1=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Checks if a unit is fleeing.
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50
 
|arg= global
 
|gr1= Object Manipulation
 
|descr= Checks if a unit is fleeing.
<br><br>
<br><br>
Notes:
Notes:
Line 25: Line 40:
* When reaching their flee point/destination, they will change to [[combatMode]] yellow and [[speedMode]] normal.
* When reaching their flee point/destination, they will change to [[combatMode]] yellow and [[speedMode]] normal.
* With [[allowFleeing]] one can make unit's flee earlier (or essentially never flee). Apply it, overrides the courage subskill influence.
* With [[allowFleeing]] one can make unit's flee earlier (or essentially never flee). Apply it, overrides the courage subskill influence.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Boolean]] <nowiki>=</nowiki> '''fleeing''' unitName |SYNTAX=
|s1= [[fleeing]] unit


|p1= unitName: [[Object]] |PARAMETER1=
|p1= unit: [[Object]]


| [[Boolean]] - Returns true if a unit is fleeing, false if not. Dead or empty units return false. |RETURNVALUE=
|r1= [[Boolean]] - returns [[true]] if a unit is fleeing, [[false]] if not. '''Dead''' or '''empty''' units return [[false]].
____________________________________________________________________________________________
 
|x1= <pre>? (fleeing _east_unit) : player sideChat "We have won!"</pre> |EXAMPLE1=
____________________________________________________________________________________________


|[[allowFleeing]]|SEEALSO=
|x1= <sqf>if (fleeing soldier_1) then {player sideChat "We have won!"} else {player sideChat "Keep fighting!"};</sqf>


|seealso= [[allowFleeing]]
}}
}}
<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|FLEEING]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|FLEEING]]
[[Category:Scripting Commands OFP 1.46|FLEEING]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 15:47, 8 November 2023

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

Description

Description:
Checks if a unit is fleeing.

Notes:
  • Fleeing only affects AI led groups.
  • Only the group as a whole can flee (or not).
  • The courage of the AI group is based on the group's leader courage subskill.
  • Each group has a max strength (summed "armor" of all infantry units - plus armor when inside vehicles).
  • If the group losses by injury/damage or death/destruction are higher than the max strength, multiplied by leader's courage or allowFleeing level , then the group will start fleeing.
  • As result primarily the AI flees to a nearby "supply point" (some friendly units - preferably with medic or engineer, or a vehicle with repair/ammo/fuel cargo). Alternatively it will try to find a safe position within a 600m radius from the initial waypoint (danger, distance, amount of cover positions are taken into account).
  • After the fleeing has been finished the group's initial strength is reset.
  • Fleeing units in combatMode red, will be set to yellow when fleeing to avoid engaging enemies while doing so.
  • While fleeing, the group leader will be set to green, to avoid giving engage or fire orders, unless in combatMode blue already. Also speedMode is set to full.
  • When reaching their flee point/destination, they will change to combatMode yellow and speedMode normal.
  • With allowFleeing one can make unit's flee earlier (or essentially never flee). Apply it, overrides the courage subskill influence.
Groups:
Object Manipulation

Syntax

Syntax:
fleeing unit
Parameters:
unit: Object
Return Value:
Boolean - returns true if a unit is fleeing, false if not. Dead or empty units return false.

Examples

Example 1:
if (fleeing soldier_1) then {player sideChat "We have won!"} else {player sideChat "Keep fighting!"};

Additional Information

See also:
allowFleeing

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=fleeing&oldid=349082"