BIS fnc wpRestricted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...)
Line 1: Line 1:
{{Function|Comments=
{{Function| TKOH|1.00|gr1= Waypoints| RESTRICTED [[Custom_Waypoints|custom waypoint]].
 
| TKOH |Game name=
 
|1.00|Game version=
 
|gr1= Waypoints |GROUP1=
 
| RESTRICTED [[Custom_Waypoints|custom waypoint]].


Player must fly in given limits.
Player must fly in given limits.
|DESCRIPTION=
| [[Custom_Waypoints#Function|arguments]]: [limits, maxTime, failCode, visualize, warnCode]|p1= failCode: [[Array]] - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]
 
| [[Custom_Waypoints#Function|arguments]]: [limits, maxTime, failCode, visualize, warnCode] |SYNTAX=
 
|p1= failCode: [[Array]] - flight limits in format [minAlt, maxAlt, minSpeed, maxSpeed]
<br>minAlt: [[Number]] - minimal altitude in meters above ground level (default: -1)
<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>maxAlt: [[Number]] - maximal altitude in meters above ground level (default: 60)
<br>minSpeed: [[Number]] - minimal speed in km/h (default: -1)
<br>minSpeed: [[Number]] - minimal speed in km/h (default: -1)
<br>maxSpeed: [[Number]] - maximal speed in km/h (default: -1) |Parameter1=
<br>maxSpeed: [[Number]] - maximal speed in km/h (default: -1) |Parameter1=
|p2= maxTime: [[Number]] - how much time spent outside of the limits will lead to fail (default: -1) |Parameter2=
|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=
 
|p3= failCode: [[Code]] - code executed when maxTime is reached (default: {}) |PARAMETER3=
 
|p4= visualize: [[Boolean]] - true to show hint (default: false) |PARAMETER4=
 
|p5= warnCode: [[Code]] - code executed when unit get out of limits (default: {}) |Parameter5=
 
| [[Nothing]] |RETURNVALUE=
   
   
|x1= <code><nowiki>[</nowiki>[[player]], [[objNull]], 0, [250, -1, 150, -1], 30, {HSim_RestrictedFlight = [[false]]}, true] BIS_fnc_wpFormation;</code> |Example1=
|x1= <code><nowiki>[</nowiki>[[player]], [[objNull]], 0, [250, -1, 150, -1], 30, {HSim_RestrictedFlight = [[false]]}, true] BIS_fnc_wpFormation;</code>| exec=spawn
 
| exec=spawn
 
| |SEEALSO=


}}
|}}




[[Category:Take_On_Helicopters:_Functions|wpRestricted]]
[[Category:Take_On_Helicopters:_Functions|wpRestricted]]
[[Category:Function Group: Waypoints|wpRestricted]]
[[Category:Function Group: Waypoints|wpRestricted]]

Revision as of 10:57, 18 January 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] 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