BIS fnc wpFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p4=" to "|PARAMETER3= |p4=")
m (Text replacement - "<br />" to "<br>")
Line 17: Line 17:
|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation |Parameter1=
|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation |Parameter1=
|p2= maxTime: [[Number]] - Time required to be spent in formation (default: 0)
|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 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.|Parameter2=
<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]
|p3= relPos: [[Array]] - in format [relDist, relAngle]
<br />relDist: [[Number]] - required distance in meters from followed target (default: 100m)
<br>relDist: [[Number]] - required distance in meters from followed target (default: 100m)
<br />relAngle [[Number]] - required relative angle in degrees from followed target (default: 180) |PARAMETER3=
<br>relAngle [[Number]] - required relative angle in degrees from followed target (default: 180) |PARAMETER3=


|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |PARAMETER4=
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |PARAMETER4=

Revision as of 13:20, 19 March 2020

Hover & click on the images for description

Description

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

Syntax

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

Examples

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

Additional Information

See also:
See also needed

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

Notes

Bottom Section