Difference between revisions of "BIS fnc wpRestricted"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " | TKOH|1.00|gr1=" to " | tkoh |1.00 |game2= arma3 |version2= 0.50 |gr1=")
m (Fix regex replace)
(Tag: Undo)
Line 1: Line 1:
 
{{RV|type=function
 
{{RV|type=function
| tkoh
+
 
|1.00
+
|game1= tkoh
 +
|version1= 1.00
  
 
|game2= arma3
 
|game2= arma3
 
|version2= 0.50
 
|version2= 0.50
  
|gr1= Waypoints| RESTRICTED [[Custom_Waypoints|custom waypoint]].
+
|gr1= Waypoints
 +
 
 +
|descr= RESTRICTED [[Custom_Waypoints|custom waypoint]].
  
 
Player must fly in given limits.
 
Player must fly in given limits.
|s1=  [[Custom_Waypoints#Function|arguments]]: [limits, maxTime, failCode, visualize, warnCode][[]]
 
 
|p1= failCode: [[Array]] - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]
 
<br>minAlt: [[Number]] - minimal altitude in meters above ground level (default: -1)
 
<br>maxAlt: [[Number]] - maximal altitude in meters above ground level (default: 60)
 
<br>minSpeed: [[Number]] - minimal speed in km/h (default: -1)
 
<br>maxSpeed: [[Number]] - maximal speed in km/h (default: -1)
 
|p2= maxTime: [[Number]] - how much time spent outside of the limits will lead to fail (default: -1)|p3= failCode: [[Code]] - code executed when maxTime is reached (default: {})|p4= visualize: [[Boolean]] - true to show hint (default: false)|p5= warnCode: [[Code]] - code executed when unit get out of limits (default: {})|r1= [[Nothing]]
 
  
|x1= <code><nowiki>[</nowiki>[[player]], [[objNull]], 0, [250, -1, 150, -1], 30, {HSim_RestrictedFlight = [[false]]}, true] BIS_fnc_wpFormation;</code>| exec=spawn
+
|exec= spawn
 +
 
 +
|s1= [[Custom_Waypoints#Function|arguments]]: [limits, maxTime, failCode, visualize, warnCode]
 +
 
 +
|p1= failCode: [[Array]] - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]:
 +
* minAlt: [[Number]] - minimal altitude in meters above ground level (default: -1)
 +
* maxAlt: [[Number]] - maximal altitude in meters above ground level (default: 60)
 +
* minSpeed: [[Number]] - minimal speed in km/h (default: -1)
 +
* maxSpeed: [[Number]] - maximal speed in km/h (default: -1)
 +
 
 +
|p2= maxTime: [[Number]] - how much time spent outside of the limits will lead to fail (default: -1)
 +
 
 +
|p3= failCode: [[Code]] - code executed when maxTime is reached (default: {})
 +
 
 +
|p4= visualize: [[Boolean]] - true to show hint (default: false)
 +
 
 +
|p5= warnCode: [[Code]] - code executed when unit get out of limits (default: {})
 +
 
 +
|r1= [[Nothing]]
  
|}}
+
|x1= <code>[<nowiki/>[[player]], [[objNull]], 0, [250, -1, 150, -1], 30, { HSim_RestrictedFlight = [[false]] }, [[true]]] [[spawn]] [[BIS_fnc_wpFormation]];</code>
  
[[Category:Take_On_Helicopters:_Functions|wpRestricted]]
+
|seealso=
[[Category:Function Group: Waypoints|wpRestricted]]
+
}}

Revision as of 16:31, 13 June 2021

Hover & click on the images for description

Description

Description:
RESTRICTED custom waypoint. Player must fly in given limits.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
arguments: [limits, maxTime, failCode, visualize, warnCode]
Parameters:
failCode: Array - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]:
  • minAlt: Number - minimal altitude in meters above ground level (default: -1)
  • maxAlt: Number - maximal altitude in meters above ground level (default: 60)
  • minSpeed: Number - minimal speed in km/h (default: -1)
  • maxSpeed: Number - maximal speed in km/h (default: -1)
maxTime: Number - how much time spent outside of the limits will lead to fail (default: -1)
failCode: Code - code executed when maxTime is reached (default: {})
visualize: Boolean - true to show hint (default: false)
warnCode: Code - code executed when unit get out of limits (default: {})
Return Value:
Nothing

Examples

Example 1:
[player, objNull, 0, [250, -1, 150, -1], 30, { HSim_RestrictedFlight = false }, 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