BIS fnc wpFormation: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function| TKOH|1.00|gr1= Waypoints| FORMATION [[Custom_Waypoints|custom waypoint]]. | ||
| TKOH | |||
|1.00 | |||
|gr1= Waypoints | |||
| FORMATION [[Custom_Waypoints|custom waypoint]]. | |||
Player must stay within certain radius and angle towards followed vehicle. | Player must stay within certain radius and angle towards followed vehicle. | ||
| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize]|p1= failCode: [[Number]] - Code executed if unit spends too long outside formation |Parameter1= | |||
| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize] | |||
|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. | <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] | ||
|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) | <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]] |RETURNVALUE= | ||
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) | |||
|p5= visualize: [[Boolean]] - true to show hint (default: false) | |||
| [[Nothing]] |RETURNVALUE= | |||
|x1= <code><nowiki>[</nowiki>[[player]], dude, 80, {HSim_keptFormation = [[false]]}, -60, [80,160], 20, [[true]]] BIS_fnc_wpFormation;</code> | |x1= <code><nowiki>[</nowiki>[[player]], dude, 80, {HSim_keptFormation = [[false]]}, -60, [80,160], 20, [[true]]] BIS_fnc_wpFormation;</code>| exec=spawn | ||
| exec=spawn | |||
}} | |}} | ||
[[Category:Take_On_Helicopters:_Functions|wpFormation]] | [[Category:Take_On_Helicopters:_Functions|wpFormation]] | ||
[[Category:Function Group: Waypoints|wpFormation]] | [[Category:Function Group: Waypoints|wpFormation]] | ||
Revision as of 09:55, 18 January 2021
Description
- Description:
- FORMATION custom waypoint. Player must stay within certain radius and angle towards followed vehicle.
- Execution:
- spawn
- Groups:
- Waypoints
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