Orbit StudiosOrbit Studios
Orbit Studios Resourcesorbit-dynamichud

Exports

Exports and integration events available in orbit-dynamichud.

Exports

DynamicHUD exposes both client and server integration points. Use the client exports from client scripts when you want to update the local player's HUD UI, and use the server export when server code needs to show or hide a player's HUD.

Prop

Type

resources/[custom]/client/main.lua
exports['orbit-dynamichud']:SeatbeltState(true)
exports['orbit-dynamichud']:CruiseControlState(false)

exports['orbit-dynamichud']:toggleHud(false)

The client toggleHud(false) export asks the server to set Player(source).state["hud:showHud"] = false. Use toggleHud(true) to show it again.

resources/[custom]/server/main.lua
exports['orbit-dynamichud']:toggleHud(source, true)

Notification examples now live in Interface.

For custom seatbelt or cruise resources, prefer setting LocalPlayer.state.seatbelt and LocalPlayer.state.cruise when possible. The Orbit addon does this automatically and also triggers the compatibility events DynamicHUD listens for.

On this page