BIS fnc wpFormation: Difference between revisions

Revision as of 16:14, 13 June 2021

Game1 needed - Version1 needed

Hover & click on the images for description

Description:: This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Execution:: spawn
Groups:: Waypoints

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 3: / Line 3: @@
 Player must stay within certain radius and angle towards followed vehicle.
-| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize]|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation
+|s1=  [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize][[]]
+|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation
 |p2= maxTime: [[Number]] - Time required to be spent in formation (default: 0)
 <br>When > 0, waypoint is completed once maxTime was reached.