BIS fnc wpFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |game1= tkoh |version1= 1.00 |game2= arma3 |version2= 0.50 " to " |game1= tkoh |version1= 1.00 ")
m (Text replacement - "arguments" to "Custom Waypoint arguments")
Line 12: Line 12:
|exec=spawn
|exec=spawn


|s1= [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize]
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [failCode, maxTime, relPos, diffAlt, visualize]


|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation
|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation

Revision as of 13:28, 1 July 2022

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