BIS fnc wpFormation: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
Lou Montana (talk | contribs) m (Text replacement - " |game1= tkoh |version1= 1.00 |game2= arma3 |version2= 0.50 " to " |game1= tkoh |version1= 1.00 ") |
||
(23 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=function | ||
| | |game1= tkoh | ||
|version1= 1.00 | |||
| | |gr1= Waypoints | ||
| FORMATION [[Custom_Waypoints|custom waypoint]]. | |descr= 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. | ||
| | |exec=spawn | ||
| | |s1= [[Custom_Waypoints#Function|arguments]]: [failCode, maxTime, relPos, diffAlt, visualize] | ||
| | |p1= failCode: [[Number]] - Code executed if unit spends too long outside formation | ||
|p2= 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 | |||
| | |p3= 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) | |||
|p4= diffAlt: [[Number]] - Altitude tolerance in meters (default: -1) | |||
|p5= visualize: [[Boolean]] - true to show hint (default: false) | |||
|r1= [[Nothing]] | |||
< | |x1= <code>[<nowiki/>[[player]], dude, 80, { HSim_keptFormation = [[false]] }, -60, [80,160], 20, [[true]]] [[spawn]] [[BIS_fnc_wpFormation]];</code> | ||
|seealso= | |||
}} |
Revision as of 18:54, 14 June 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]:
- 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