BIS fnc wpFormation: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 10: Line 10:


Player must stay within certain radius and angle towards followed vehicle.
Player must stay within certain radius and angle towards followed vehicle.
  |= Description
  |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize] |= Syntax
| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize] |SYNTAX=


|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation |=
|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation |=
Line 25: Line 25:
|p5= visualize: [[Boolean]] - true to show hint (default: false) |=
|p5= visualize: [[Boolean]] - true to show hint (default: false) |=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
Line 33: Line 33:
| exec=spawn |=
| exec=spawn |=


| |= See also
| |SEEALSO=


}}
}}

Revision as of 14:34, 7 April 2019

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