Features
Exports
Client Exports

Client Exports

HUD Visibility

Show, hide, or toggle the entire HUD at runtime. This is separate from the player-loaded lifecycle — it's intended for scripts that need to clear the screen (cutscenes, minigames, photo mode, etc.).

exports["bablo-hud"]:ShowHud()
exports["bablo-hud"]:HideHud()
exports["bablo-hud"]:ToggleHud()
 
-- return: bool - whether the HUD is currently visible
exports["bablo-hud"]:IsHudVisible()

Per-Component Visibility

Hide or show individual HUD components. Useful when you only want to suppress part of the HUD (e.g. hide the player info panel during a cutscene but keep the speedometer).

Valid component names: status, speedometer, playerInfo, minimap, voice, notifications, progressBar, controlHints

-- component: string - one of the names listed above
-- visible:   bool   - true to show, false to hide
 
exports["bablo-hud"]:SetComponentVisible(component, visible)
 
-- return: bool - whether the component is currently visible
exports["bablo-hud"]:IsComponentVisible(component)

Examples:

-- Hide just the player info panel
exports["bablo-hud"]:SetComponentVisible("playerInfo", false)
 
-- Hide the minimap (also hides the native GTA radar)
exports["bablo-hud"]:SetComponentVisible("minimap", false)
 
-- Restore the speedometer
exports["bablo-hud"]:SetComponentVisible("speedometer", true)

Notifications

Show a notification with a title, body, type and duration.

-- title:    string - notification title
-- body:     string - notification body text
-- type:     string - "primary" | "success" | "error" | "info" | "warning"
-- duration: number - duration in milliseconds
 
exports["bablo-hud"]:Notify(title, body, type, duration)

Progress Bar

Start a progress bar.

-- data: table
--   duration: number - duration in milliseconds
--   label:    string - label shown above the bar
--   canCancel: bool  - can the player cancel it
--   disable:  table  - disables controls while active (e.g. { move = true })
--   anim:     table  - optional animation
--   prop:     table  - optional prop
 
exports["bablo-hud"]:ProgressBar(data)

Stop Progress Bar

Stops the current progress bar if one is running.

exports["bablo-hud"]:StopProgressBar()

Cinematic Mode

Toggle, set, or query the cinematic letterbox mode.

-- active: bool - whether cinematic mode is active
 
exports["bablo-hud"]:SetCinematic(active)
exports["bablo-hud"]:ToggleCinematic()
 
-- return: bool - whether cinematic mode is currently active
exports["bablo-hud"]:IsCinematicActive()

Seatbelt

Toggle the seatbelt or check the current state. Requires Config.Seatbelt.enabled = true.

exports["bablo-hud"]:ToggleSeatbelt()
 
-- return: bool - whether the seatbelt is fastened
exports["bablo-hud"]:IsSeatbeltOn()

Stress System

Read and write the integrated stress value. Requires Config.Stress.integrated = true.

-- return: number - current stress value (0-100)
exports["bablo-hud"]:GetStress()
 
-- value:  number - new stress value (clamped to config min/max)
exports["bablo-hud"]:SetStress(value)
 
-- amount: number - amount to add
exports["bablo-hud"]:AddStress(amount)
 
-- amount: number - amount to remove
exports["bablo-hud"]:RemoveStress(amount)

Minimap

Utilities to work with the styled minimap.

-- return: table - x, y, w, h anchor of the minimap in screen space
exports["bablo-hud"]:getAnchor()
 
-- visible: bool - show or hide the native radar
exports["bablo-hud"]:setRadarVisible(visible)