Duty HUD
Client exports to show, hide and query the duty HUD.
showDutyHUD
Un-hides the duty HUD. Idempotent calling it while the HUD is already visible is harmless.
local ok, err = exports['hex_jobscreator']:showDutyHUD()Returns
| Value | Meaning |
|---|---|
true | HUD un-hidden |
false, 'dutyhud_disabled' | the duty HUD is switched off in the config |
hideDutyHUD
Hides the duty HUD and keeps it hidden across job changes and duty toggles until showDutyHUD() is
called. Also cancels HUD move mode if the player is in it, and blocks move mode while hidden.
local ok, err = exports['hex_jobscreator']:hideDutyHUD()Returns
| Value | Meaning |
|---|---|
true | HUD hidden |
false, 'dutyhud_disabled' | the duty HUD is switched off in the config |
isDutyHudVisible
Whether the duty HUD is currently on screen.
local visible, err = exports['hex_jobscreator']:isDutyHudVisible()Returns
| Value | Meaning |
|---|---|
true | on screen |
false, reason | see the reasons below |
Reasons
| Code | Meaning |
|---|---|
dutyhud_disabled | the duty HUD is switched off in the config |
hidden | hidden via hideDutyHUD |
no_duty_job | nothing to show no job with a duty point |