BIS fnc wpFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "| Nothing " to "|r1= Nothing ")
Line 8: Line 8:
<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.|p3= relPos: [[Array]] - in format [relDist, relAngle]
<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.|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)|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1)|p5= visualize: [[Boolean]] - true to show hint (default: false)| [[Nothing]]
<br>relAngle [[Number]] - required relative angle in degrees from followed target (default: 180)|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1)|p5= visualize: [[Boolean]] - true to show hint (default: false)|r1= [[Nothing]]


|x1= <code><nowiki>[</nowiki>[[player]], dude, 80, {HSim_keptFormation = [[false]]}, -60, [80,160], 20, [[true]]] BIS_fnc_wpFormation;</code>| exec=spawn
|x1= <code><nowiki>[</nowiki>[[player]], dude, 80, {HSim_keptFormation = [[false]]}, -60, [80,160], 20, [[true]]] BIS_fnc_wpFormation;</code>| exec=spawn

Revision as of 22:34, 10 June 2021

Hover & click on the images for description

Description

Description:
Description needed
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Syntax needed
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