BIS fnc wpFormation: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
m (Text replacement - "|Game version=" to "|Game version= |gr1= Waypoints |GROUP1=") |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function|= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| TKOH | | | TKOH |Game name= | ||
|1.00| | |1.00|Game version= | ||
|gr1= Waypoints |GROUP1= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 15: | Line 17: | ||
| [[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 |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 | <br>When > 0, waypoint is completed once maxTime was reached. | ||
<br | <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.|Parameter2= | ||
|p3= relPos: [[Array]] - in format [relDist, relAngle] | |p3= relPos: [[Array]] - in format [relDist, relAngle] | ||
<br | <br>relDist: [[Number]] - required distance in meters from followed target (default: 100m) | ||
<br | <br>relAngle [[Number]] - required relative angle in degrees from followed target (default: 180) |PARAMETER3= | ||
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |= | |||
|p5= visualize: [[Boolean]] - true to show hint (default: false) |= | |p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |PARAMETER4= | ||
|p5= visualize: [[Boolean]] - true to show hint (default: false) |Parameter5= | |||
| [[Nothing]] |RETURNVALUE= | | [[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> |Example1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 11:38, 4 October 2020
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