Exports

orbit-dynamichud- Exports for the resource.

📦 Exports

Orbit Dynamic HUD exposes several exports that allow other resources to control HUD behavior and speedometer states.

These exports are available on both server and client.

---

🖥️ Server Exports

toggleHud

Toggle the visibility of the HUD for a specific player.

✅ Syntax

exports["orbit-dynamichud"]:toggleHud(source, bool)

📥 Parameters

Name	Type	Description
source	number	Player server ID
bool	boolean	true to show HUD, false to hide

📌 Example

local playerId = source

exports["orbit-dynamichud"]:toggleHud(playerId, false)

🧠 Notes

• Uses player state bags internally (hud:showHud).

• Replicates to the client automatically.

• Useful for cutscenes, spectate, onboarding, etc.

---

💻 Client Exports

These exports allow updating speedometer constants such as seatbelt and cruise control.

---

SeatbeltState

Updates the seatbelt indicator in the speedometer.

✅ Syntax

exports["orbit-dynamichud"]:SeatbeltState(state)

📥 Parameters

Name	Type	Description
state	boolean	true if seatbelt is on

📌 Example

exports["orbit-dynamichud"]:SeatbeltState(true)

🧠 Behavior

• Sends an NUI message with the updated seatbelt state

• Only updates UI constants — no gameplay logic included

---

CruiseControlState

Updates the cruise control indicator in the speedometer.

✅ Syntax

exports["orbit-dynamichud"]:CruiseControlState(state)

📥 Parameters

Name	Type	Description
state	boolean	true if cruise control is active

📌 Example

exports["orbit-dynamichud"]:CruiseControlState(true)

🧠 Behavior

• Sends an NUI message updating cruise control status

• Purely visual indicator

---

🔗 Integration Example

-- Toggle HUD server side
exports["orbit-dynamichud"]:toggleHud(source, true)

-- Client side vehicle states
exports["orbit-dynamichud"]:SeatbeltState(true)
exports["orbit-dynamichud"]:CruiseControlState(false)

---

⚠️ Best Practices

• Call seatbelt/cruise exports only when state changes (avoid spamming NUI).

• Use toggleHud instead of custom events when hiding HUD.

• Keep gameplay logic outside the HUD resource.

---