ShowNativeHud
showNativeHud
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.
Set this client resource's visibility policy for all six passive native HUD groups. It does not disable native menus.
Syntax
requestId = showNativeHud(visible)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
visible |
boolean |
yes | false hides all HUD groups; true releases this resource's HUD restrictions. |
Returns
Positive numeric request ID if queued, or false if rejected. This is not an application acknowledgement.
Examples
local requestId = showNativeHud(false)
-- Later, restore only this resource's HUD policy:
showNativeHud(true)
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.