Difference between revisions of "BIS fnc wpSteady"

Latest revision as of 22:56, 12 July 2022

1.00

Hover & click on the images for description

Description

Description:: FLY STEADY custom waypoint. Keep helicopter's pitch, bank, relative velocity a relative vector in given limits
Execution:: spawn
Groups:: Waypoints

Syntax

Syntax:

Custom Waypoint arguments: [limitArray, failLimit, failCode, warningCode, positiveCode]

Parameters:

limitArray: Array - in format [deltaVelocity, deltaVector, vector]:

deltaVelocity: Number - how much can velocity change (default: 20)
deltaVector: Number - how much can vector direction change (default: 1.5)
vector: Number - absolute vector limits for pitch and bank in degrees (default: 45)

failLimit: Number - what time in seconds spent outside of limits will lead to fail (default: -1)

failCode: Code - code executed when waypoint fails - time spent outside of limits reached failLimit (default: {})

warningCode: Code - code spawned every time vehicle is outside of limits (default: {})

positiveCode: Code - code spawned every time vehicle is inside of limits (default: {})

Return Value:

Nothing

Examples

Example 1:: [ player, position dude, nil, [15,1.3,30], 10, { hintC "You failed"; }, { hint "Watch out!"; }, { hint "Good"; } ] spawn BIS_fnc_wpSteady;

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
-____________________________________________________________________________________________
-| FLY STEADY [[Custom_Waypoints|custom waypoint]].
+|exec= spawn
+|descr= FLY STEADY [[Custom_Waypoints|custom waypoint]].
 Keep helicopter's pitch, bank, relative velocity a relative vector in given limits
- |DESCRIPTION=
-____________________________________________________________________________________________
-| [[Custom_Waypoints#Function|arguments]]: [limitArray,failLimit,failCode,warningCode,positiveCode] |SYNTAX=
+|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [limitArray, failLimit, failCode, warningCode, positiveCode]
-|p1= limitArray: [[Array]] - in format [deltaVelocity,deltaVector,vector]
+|p1= limitArray: [[Array]] - in format [deltaVelocity, deltaVector, vector]:
-<br />deltaVelocity: [[Number]] - how much can [[velocity]] change (default: 20)
+* deltaVelocity: [[Number]] - how much can [[velocity]] change (default: 20)
-<br />deltaVector: [[Number]] - how much can vector direction change (default: 1.5)
+* deltaVector: [[Number]] - how much can vector direction change (default: 1.5)
-<br />vector: [[Number]] - absolute vector limits for pitch and bank in degrees (default: 45)
+* vector: [[Number]] - absolute vector limits for pitch and bank in degrees (default: 45)
-|Parameter1=
-|p2= failLimit: [[Number]] - what time in seconds spent outside of limits will lead to fail (default: -1) |=
+|p2= failLimit: [[Number]] - what time in seconds spent outside of limits will lead to fail (default: -1)
-|p3= failCode: [[Code]] - code executed when waypoint fails - time spent outside of limits reached failLimit (default: {}) |=
-|p4= warningCode: [[Code]] - code [[spawn]]ed every time vehicle is outside of limits (default: {}) |=
-|p5= positiveCode: [[Code]] - code [[spawn]]ed every time vehicle is inside of limits (default: {}) |=
-| [[Nothing]] |RETURNVALUE=
+|p3= failCode: [[Code]] - code executed when waypoint fails - time spent outside of limits reached failLimit (default: {})
-____________________________________________________________________________________________
-|x1= <code><nowiki>[</nowiki>
-	[[player]],
-	[[position]] dude,
-	[[nil]],
-	[15,1.3,30], 10, {[[hintC]] "You failed";}, {[[hint]] "Watch out!";}, {[[hint]] "Good";}
-] [[spawn]] BIS_fnc_wpSteady;</code> |EXAMPLE1=
-____________________________________________________________________________________________
+|p4= warningCode: [[Code]] - code [[spawn]]ed every time vehicle is outside of limits (default: {})
-| exec=spawn |=
-| |SEEALSO=
+|p5= positiveCode: [[Code]] - code [[spawn]]ed every time vehicle is inside of limits (default: {})
-}}
+|r1= [[Nothing]]
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>
-<dl class="command_description">
+[
-<!-- Note Section BEGIN -->
+	player,
+	position dude,
+	nil,
+	[15,1.3,30], 10, { hintC "You failed"; }, { hint "Watch out!"; }, { hint "Good"; }
+] spawn BIS_fnc_wpSteady;
+</sqf>
-<!-- Note Section END -->
+|seealso=
-</dl>
+}}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Take_On_Helicopters:_Functions|wpSteady]]
-[[Category:Function Group: Waypoints|wpSteady]]