HUD
Exports
toggleHud
Hide or show the entire HUD.
-- client only
-- show: boolean - true to show the HUD, false to hide it
exports["jg-hud"]:toggleHud(show)
-- example: hide the HUD during a cutscene
exports["jg-hud"]:toggleHud(false)toggleVehicleControl
Hide or show the vehicle control menu.
-- client only
-- show: boolean - true to show the menu, false to hide it
exports["jg-hud"]:toggleVehicleControl(show)setWeaponAmmoOverride
Overrides the clip and reserve ammo shown for the currently equipped weapon. This is useful for inventory systems that store ammo separately from GTA's native weapon ammo.
The override only changes the HUD display. It does not add or remove ammo from the weapon. It remains active until the weapon changes or clearWeaponAmmoOverride is called.
-- client only
-- clipAmmo: integer - ammo currently loaded in the weapon
-- reserveAmmo: integer - spare ammo, or -1 to show unlimited ammo
local success = exports["jg-hud"]:setWeaponAmmoOverride(clipAmmo, reserveAmmo)
-- example: show 7 rounds loaded and 21 in the inventory
exports["jg-hud"]:setWeaponAmmoOverride(7, 21)| Returns | Type | Description |
|---|---|---|
success | boolean | Whether an equipped weapon and valid values were found |
Call the export again whenever your inventory ammo changes.
clearWeaponAmmoOverride
Clears the ammo override and immediately returns the HUD to GTA's native ammo values.
-- client only
exports["jg-hud"]:clearWeaponAmmoOverride()Last updated 27 August 2026