SetNativeHudComponentVisible

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 02:08, 11 October 2026 by QCherry (talk | contribs) (Document native HUD/menu Lua APIs available since 0.1.7; client BUILD202 and save/load protection)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

setNativeHudComponentVisible

AVAILABLE FROM UPDATE 0.1.7
This function is available in G1R:MP 0.1.7 and later. The contract below includes the compatibility guarantees introduced in that update.

Hide or release one native HUD group without removing the native UI root.

Syntax

requestId = setNativeHudComponentVisible(component, visible)

Parameters

Name Type Required Description
component string yes bars, crosshair, interaction, hotbar, notifications, combat_markers, or all (case-sensitive).
visible boolean yes false hides the group; true releases this resource's restriction.

Returns

Positive numeric request ID if queued, or false if rejected. This is not an application acknowledgement. Unknown component keys return false.

Examples

setNativeHudComponentVisible("bars", false)
setNativeHudComponentVisible("interaction", false)

Notes

  • Client-side only; available since 0.1.7. Use client BUILD202 or newer with a compatible Protocol 39 server.
  • See Native HUD and menus for asynchronous acknowledgements, resource ownership, input and restoration.
  • A positive request ID means queued, not applied. Listen for onClientNativeUiResult and inspect getNativeUiState.
  • Register the handler before submitting. Rapid changes coalesce: track the latest request ID, not every intermediate ID.
  • false restricts; true releases only the calling resource's restriction. Other resources remain respected.
  • This does not change inventory data, player attributes or custom RmlUi documents. Native save/load cannot be re-enabled.