BIS fnc HUDLimits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|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
* default value is 0, which means no limits were assigned
* using 0 in min or max value will hide the corresponding limit
* using 0 in min or max value will hide the corresponding limit
* same or higher priority will replace currently set priority
* 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]:
|p1= speedLimit: [[Array]] in format [priority, min, max]:
* priority: [[Number]]
* priority: [[Number]]
* min: [[Number]]
* min: [[Number]]
* max: [[Number]] |= Parameter 1
* max: [[Number]]


|p2= altLimit: [[Array]] in format [priority, min, max]:
|p2= altLimit: [[Array]] in format [priority, min, max]:
* priority: [[Number]]
* priority: [[Number]]
* min: [[Number]]
* min: [[Number]]
* max: [[Number]] |= Parameter 1
* max: [[Number]]


|p3= dirLimit: [[Array]] in format [priority, min, max, target]:
|p3= dirLimit: [[Array]] in format [priority, min, max, target]:
Line 33: Line 33:
* min: [[Number]] - you can set a "negative" value by adding 360 (e.g using 270 instead of -90)
* min: [[Number]] - you can set a "negative" value by adding 360 (e.g using 270 instead of -90)
* max: [[Number]]
* max: [[Number]]
* target: [[Position]] or [[Object]] - (Optional, default [0,0,0]) the direction relative target |= Parameter 1
* target: [[Position]] or [[Object]] - (Optional, default [0,0,0]) the direction relative target


| [[Array]] - current value of [[HUDMovementLevels]] |RETURNVALUE=
|r1= [[Array]] - current value of [[HUDMovementLevels]]
____________________________________________________________________________________________


|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> |= Example 1
|x1= <sqf>[[0,0,0], [1, 0, 50], [0,0,0]] call BIS_fnc_HUDLimits; // limits altitude on HUD to 50m max</sqf>


|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> |= Example 2
|x2= <sqf>[[0,0,0], [0, 0, 0], [1,330,30, myTarget]] call BIS_fnc_HUDLimits; // limits orientation towards myTarget by ±30°</sqf>
____________________________________________________________________________________________
 
| [[HUDMovementLevels]], [[setHUDMovementLevels]] |SEEALSO=


|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:Function Group: GUI|{{uc:HUDLimits}}]]
[[Category:Functions|{{uc:HUDLimits}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:HUDLimits}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:HUDLimits}}]]

Latest revision as of 15:25, 13 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
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]:
altLimit: Array in format [priority, min, max]:
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_HUDLimits&oldid=327970"