BIS fnc wpFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
Line 16: Line 16:
|p1= failCode: [[Number]] - code executed if unit spends too long outside formation
|p1= failCode: [[Number]] - code executed if unit spends too long outside formation


|p2= maxTime: [[Number]] - Time required to be spent in formation (default: 0)
|p2= 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 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
* when <= 0, waypoint is completed only when waypoint condition was met (always [[false]] in Function execution), and ''failCode'' is executed once ''maxTime'' is reached

Latest revision as of 15:50, 8 November 2023

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:
Waypoints

Syntax

Syntax:
Custom Waypoint 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] spawn 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