Orbit StudiosOrbit Studios
Orbit Studios Resourcesorbit-dynamichud-v2Interface APIs

QBX integration

Route Qbox notifications and QB-compatible interface calls to Orbit Dynamic HUD 2.0.

QBX integration

Qbox's client Notify export calls lib.notify. Its QB-compatibility layer uses ox_lib for other interfaces. The server Notify path is separate. Keep ox_lib installed for Qbox's other features; replacing an interface does not replace the framework dependency.

Calls in your own resources

Replace a client-side exports.qbx_core:Notify(text, type, duration, subTitle) with the HUD export:

exports['orbit-dynamichud-v2']:notify({
    title = 'Garage',
    description = 'Vehicle stored.',
    type = 'success',
    duration = 4000
})

When the Qbox text argument is a table, map its text field to HUD title and caption to description. When it is a string with subTitle, use the string as title and the subtitle as description; a plain string can be the HUD description. Qbox-only position/style options are not 1:1 HUD options.

Replace a server-side exports.qbx_core:Notify(source, ...) in your own script with:

TriggerClientEvent('orbit-dynamichud:notify', source, {
    description = 'Vehicle stored.',
    type = 'success',
    duration = 4000
})

For scripts already using lib.notify, lib.showTextUI, lib.skillCheck, or lib.progressBar, load the complete ox_lib compatibility bridge inside that resource, after @ox_lib/init.lua. This keeps their established signatures and the HUD's progress boolean return. lib.progressCircle renders the HUD's progress bar.

QB compatibility calls

Qbox's QB compatibility layer accepts QBCore.Functions.Notify, QBCore.Functions.Progressbar, and DrawText-like calls. If your script calls those APIs, use the QB-Core migration guide to migrate its call sites. QB-style progress is callback-based; do not replace it with a blocking HUD call inside a non-yielding callback without a thread. The Qbox bridge may internally call lib.progressBar and lib.showTextUI, but overriding lib in a third-party resource does not modify qbx_core's own Lua environment.

Replacing Qbox's own client UI

If you maintain a Qbox fork and need framework-generated UI to use the HUD, load client/orbit_ui_bridge.lua from the ox_lib bridge guide in qbx_core itself. Add it to qbx_core/fxmanifest.lua as the first client_scripts entry, after the existing shared @ox_lib/init.lua has loaded:

qbx_core/fxmanifest.lua (excerpt)
client_scripts {
    'client/orbit_ui_bridge.lua',
    'client/main.lua',
    -- Keep the remaining existing qbx_core client scripts in their original order.
}

Keep ox_lib and its manifest entry; Qbox uses it beyond the four interfaces. This redirects qbx_core's client-side lib.notify, progress, Text UI, and skill checks in its own Lua environment. It does not automatically redirect qbx_core's server-side Notify implementation if that implementation emits ox_lib:notify directly. Migrate that server path separately in your maintained fork, or migrate the server call sites in your own resources. Confirm the exact paths in your installed Qbox revision before editing, keep a backup, and reapply/test changes after Qbox updates.

Never register a second handler just to display the same framework event without disabling the original display path. Test one client notification, one server notification, Text UI show/hide, progress success/cancel, and an existing QB-compatibility resource before removing any old interface UI.

On this page