BIS fnc wpRestricted: Difference between revisions

Latest revision as of 18:11, 13 July 2022

1.00

Hover & click on the images for description

Description

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

Syntax

Syntax:

Custom Waypoint 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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| TKOH |= Game name
+|game1= tkoh
+|version1= 1.00
-|1.00|= Game version
+|gr1= Waypoints
-____________________________________________________________________________________________
-| RESTRICTED [[Custom_Waypoints|custom waypoint]].
+|descr= RESTRICTED [[Custom_Waypoints|custom waypoint]].
 Player must fly in given limits.
- |DESCRIPTION=
-____________________________________________________________________________________________
-| [[Custom_Waypoints#Function|arguments]]: [limits, maxTime, failCode, visualize, warnCode] |SYNTAX=
+|exec= spawn
-|p1= failCode: [[Array]] - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]
+|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [limits, maxTime, failCode, visualize, warnCode]
-<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: {}) |=
-| [[Nothing]] |RETURNVALUE=
+|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)
-|x1= <code><nowiki>[</nowiki>[[player]], [[objNull]], 0, [250, -1, 150, -1], 30, {HSim_RestrictedFlight = [[false]]}, true] BIS_fnc_wpFormation;</code> |=
+* 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)
-| exec=spawn |=
-| |SEEALSO=
+|p3= failCode: [[Code]] - code executed when maxTime is reached (default: {})
-}}
+|p4= visualize: [[Boolean]] - true to show hint (default: false)
-<h3 style="display:none">Notes</h3>
+|p5= warnCode: [[Code]] - code executed when unit get out of limits (default: {})
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|r1= [[Nothing]]
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x1= <sqf>[player, objNull, 0, [250, -1, 150, -1], 30, { HSim_RestrictedFlight = false }, true] spawn BIS_fnc_wpFormation;</sqf>
-[[Category:Take_On_Helicopters:_Functions|wpRestricted]]
+|seealso=
-[[Category:Function Group: Waypoints|wpRestricted]]
+}}