Difference between revisions of "BIS fnc wpSteady"

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 |Game name=
+
| TKOH
  
|1.00|Game version=
+
|1.00
  
|gr1= Waypoints |GROUP1=
+
|gr1= Waypoints
  
 
| FLY STEADY [[Custom_Waypoints|custom waypoint]].
 
| FLY STEADY [[Custom_Waypoints|custom waypoint]].
  
 
Keep helicopter's pitch, bank, relative velocity a relative vector in given limits
 
Keep helicopter's pitch, bank, relative velocity a relative vector in given limits
|DESCRIPTION=
 
  
| [[Custom_Waypoints#Function|arguments]]: [limitArray,failLimit,failCode,warningCode,positiveCode] |SYNTAX=
+
 
 +
| [[Custom_Waypoints#Function|arguments]]: [limitArray,failLimit,failCode,warningCode,positiveCode]
  
 
|p1= limitArray: [[Array]] - in format [deltaVelocity,deltaVector,vector]
 
|p1= limitArray: [[Array]] - in format [deltaVelocity,deltaVector,vector]
Line 18: Line 18:
 
<br>deltaVector: [[Number]] - how much can vector direction change (default: 1.5)
 
<br>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)
 
<br>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) |Parameter2=
 
  
|p3= failCode: [[Code]] - code executed when waypoint fails - time spent outside of limits reached failLimit (default: {}) |PARAMETER3=
+
|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: {}) |PARAMETER4=
+
|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: {}) |Parameter5=
+
|p5= positiveCode: [[Code]] - code [[spawn]]ed every time vehicle is inside of limits (default: {})
  
| [[Nothing]] |RETURNVALUE=
+
| [[Nothing]]
 
   
 
   
 
|x1= <code><nowiki>[</nowiki>
 
|x1= <code><nowiki>[</nowiki>
Line 35: Line 35:
 
[[nil]],
 
[[nil]],
 
[15,1.3,30], 10, {[[hintC]] "You failed";}, {[[hint]] "Watch out!";}, {[[hint]] "Good";}
 
[15,1.3,30], 10, {[[hintC]] "You failed";}, {[[hint]] "Watch out!";}, {[[hint]] "Good";}
] [[spawn]] BIS_fnc_wpSteady;</code> |EXAMPLE1=
+
] [[spawn]] BIS_fnc_wpSteady;</code>
  
 
| exec=spawn
 
| exec=spawn
  
| |SEEALSO=
+
|
  
 
}}
 
}}

Revision as of 10:11, 18 January 2021

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:
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