BIS fnc HUDLimits: Difference between revisions

Latest revision as of 15:25, 13 July 2022

Hover & click on the images for description

Description

Description:

Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also setHUDMovementLevels.

ⓘ

default value is 0, which means no limits were assigned
using 0 in min or max value will hide the corresponding limit
same or higher priority will replace currently set priority
using a negative priority will reset the values if absolute value is same or higher than current level

Execution:

call

Groups:

GUI

Syntax

Syntax:

[speedLimit, altLimit, dirLimit] call BIS_fnc_HUDLimits

Parameters:

speedLimit: Array in format [priority, min, max]:

priority: Number
min: Number
max: Number

altLimit: Array in format [priority, min, max]:

priority: Number
min: Number
max: Number

dirLimit: Array in format [priority, min, max, target]:

priority: Number
min: Number - you can set a "negative" value by adding 360 (e.g using 270 instead of -90)
max: Number
target: Position or Object - (Optional, default [0,0,0]) the direction relative target

Return Value:

Array - current value of HUDMovementLevels

Examples

Example 1:: [[0,0,0], [1, 0, 50], [0,0,0]] call BIS_fnc_HUDLimits; // limits altitude on HUD to 50m max
Example 2:: [[0,0,0], [0, 0, 0], [1,330,30, myTarget]] call BIS_fnc_HUDLimits; // limits orientation towards myTarget by ±30°

Additional Information

See also:: HUDMovementLevels setHUDMovementLevels

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=
+|game2= arma3
+|version2= 0.50
-|gr1= GUI |GROUP1=
+|gr1= GUI
-| Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also [[setHUDMovementLevels]].<br>
+|descr= Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also [[setHUDMovementLevels]].
-<br>
+{{Feature|informative|
-Notes:
 * default value is 0, which means no limits were assigned
 * using 0 in min or max value will hide the corresponding limit
 * same or higher priority will replace currently set priority
-* using a negative priority will reset the values if absolute value is same or higher than current level |DESCRIPTION=
+* using a negative priority will reset the values if absolute value is same or higher than current level
+}}
-| [speedLimit, altLimit, dirLimit] call [[BIS_fnc_HUDLimits]] |SYNTAX=
+|s1= [speedLimit, altLimit, dirLimit] call [[BIS_fnc_HUDLimits]]
 |p1= speedLimit: [[Array]] in format [priority, min, max]:
 * priority: [[Number]]
 * min: [[Number]]
-* max: [[Number]] |PARAMETER1=
+* max: [[Number]]
 |p2= altLimit: [[Array]] in format [priority, min, max]:
 * priority: [[Number]]
 * min: [[Number]]
-* max: [[Number]] |PARAMETER2=
+* max: [[Number]]
 |p3= dirLimit: [[Array]] in format [priority, min, max, target]:
@@ Line 31: / Line 33: @@
 * min: [[Number]] - you can set a "negative" value by adding 360 (e.g using 270 instead of -90)
 * max: [[Number]]
-* target: [[Position]] or [[Object]] - (Optional, default [0,0,0]) the direction relative target |PARAMETER3=
+* target: [[Position]] or [[Object]] - (Optional, default [0,0,0]) the direction relative target
-| [[Array]] - current value of [[HUDMovementLevels]] |RETURNVALUE=
-|x1= <code><nowiki>[</nowiki>[0,0,0], [1, 0, 50], [0,0,0]] [[call]] [[BIS_fnc_HUDLimits]]; {{codecomment|// limits altitude on HUD to 50m max}}</code> |EXAMPLE1=
+|r1= [[Array]] - current value of [[HUDMovementLevels]]
-|x2= <code><nowiki>[</nowiki>[0,0,0], [0, 0, 0], [1,330,30, myTarget]] [[call]] [[BIS_fnc_HUDLimits]]; {{codecomment|// limits orientation towards myTarget by ±30°}}</code> |EXAMPLE2=
+|x1= <sqf>[[0,0,0], [1, 0, 50], [0,0,0]] call BIS_fnc_HUDLimits; // limits altitude on HUD to 50m max</sqf>
-| [[HUDMovementLevels]], [[setHUDMovementLevels]] |SEEALSO=
+|x2= <sqf>[[0,0,0], [0, 0, 0], [1,330,30, myTarget]] call BIS_fnc_HUDLimits; // limits orientation towards myTarget by ±30°</sqf>
+|seealso= [[HUDMovementLevels]] [[setHUDMovementLevels]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:{{Name|arma3}}: Functions|{{uc:HUDLimits}}]]