BIS fnc HUDLimits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Fix example)
Line 10: Line 10:
| Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also [[setHUDMovementLevels]].<br />
| Set helicopter advanced flight model HUD limits and prevents overwriting existing values. See also [[setHUDMovementLevels]].<br />
<br />
<br />
Note about priority:
Notes:
* default value is 0, which means no limits were assigned
* default value is 0, which means no limits were assigned
* using 0 will hide the limits, no matter the priorities
* 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 negative value 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 |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 31: Line 31:
|p3= dirLimit: [[Array]] in format [priority, min, max, target]:
|p3= dirLimit: [[Array]] in format [priority, min, max, target]:
* priority: [[Number]]
* priority: [[Number]]
* min: [[Number]]
* 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]] - if set, the direction will be relative to it |= Parameter 1
* target: [[Position]] or [[Object]] - (Optional, default [0,0,0]) the direction relative target |= Parameter 1


| [[Array]] - current value of [[HUDMovementLevels]] |= Return value
| [[Array]] - current value of [[HUDMovementLevels]] |= Return value
Line 40: Line 40:
|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= <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


|x2= <code><nowiki>[</nowiki>[0,0,0], [0, 0, 0], [1,0,30, myTarget]] [[call]] [[BIS_fnc_HUDLimits]]; {{codecomment|// limits orientation towards myTarget by ±30°}}</code> |= Example 2
|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
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 11:15, 22 April 2018


Hover & click on the images for description

Description

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

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
Execution:
call
Groups:
Uncategorised

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

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

Notes

Bottom Section