BIS fnc wpFormation: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Function|= Comments ____________________________________________________________________________________________ | TKOH |= Game name |1.00|= Game version ____________________...") |
Lou Montana (talk | contribs) m (Text replacement - "|= |p4=" to "|PARAMETER3= |p4=") |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Function|= | {{Function|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| TKOH | | | TKOH |Game name= | ||
|1.00| | |1.00|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | FORMATION [[Custom_Waypoints|custom waypoint]]. | ||
|= | Player must stay within certain radius and angle towards followed vehicle. | ||
|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize] |= | | [[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 />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.|Parameter2= | ||
|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) |PARAMETER3= | ||
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |= | |||
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) |PARAMETER4= | |||
|p5= visualize: [[Boolean]] - true to show hint (default: false) |= | |p5= visualize: [[Boolean]] - true to show hint (default: false) |= | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 32: | Line 36: | ||
| exec=spawn |= | | exec=spawn |= | ||
| |= | | |SEEALSO= | ||
}} | }} | ||
Revision as of 00:23, 21 December 2019
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