BIS fnc wpFormation: Difference between revisions

Revision as of 01:04, 3 September 2019

Hover & click on the images for description

Description:: FORMATION custom waypoint. Player must stay within certain radius and angle towards followed vehicle.
Execution:: spawn
Groups:: Uncategorised

Syntax:: arguments: [failCode, maxTime, relPos, diffAlt, visualize]
Parameters:: failCode: Number - Code executed if unit spends too long outside formation
: maxTime: Number - Time required to be spent in formation (default: 0)
When > 0, waypoint is completed once maxTime was reached.
When <= 0, waypoint is completed only when waypoint condition was met (always false in Function execution), and failCode is executed once maxTime is reached.
: relPos: Array - in format [relDist, relAngle]
relDist: Number - required distance in meters from followed target (default: 100m)
relAngle Number - required relative angle in degrees from followed target (default: 180)
: diffAlt: Number - Altitude tolerance in meters (default: -1)
: visualize: Boolean - true to show hint (default: false)
Return Value:: Nothing

Example 1:: [player, dude, 80, {HSim_keptFormation = false}, -60, [80,160], 20, true] BIS_fnc_wpFormation;

: 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

@@ Line 18: / Line 18: @@
 |p2= maxTime: [[Number]] - Time required to be spent in formation (default: 0)
 <br />When > 0, waypoint is completed once maxTime was reached.
-<br />When <= 0, waypoint is completed only when waypoint condition was met (always [[false]] in Function execution), and failCode is executed once maxTime is reached.|=
+<br />When <= 0, waypoint is completed only when waypoint condition was met (always [[false]] in Function execution), and failCode is executed once maxTime is reached.|Parameter2=
 |p3= relPos: [[Array]] - in format [relDist, relAngle]
 <br />relDist: [[Number]] - required distance in meters from followed target (default: 100m)