Orbit StudiosOrbit Studios
Orbit Studios Resourcesorbit-dynamichud-v2Interface APIs

Notifications

Send DynamicHUD notifications directly or replace ox_lib notifications without changing call sites.

Notifications

notify and Notify are equivalent client exports. Notifications may also be triggered through the client event.

Client export
exports['orbit-dynamichud-v2']:notify({
    title = 'Garage',
    description = 'Vehicle stored successfully.',
    type = 'success',
    duration = 3500
})
Client event
TriggerEvent('orbit-dynamichud:notify', {
    description = 'You do not have the required item.',
    type = 'error',
    duration = 4000
})

A server script targets a client:

Server event
TriggerClientEvent('orbit-dynamichud:notify', source, {
    title = 'Server',
    description = 'Welcome back.',
    type = 'info',
    duration = 3000
})

Payload

FieldTypeDefaultDescription
idstring?generatedUnique ID. A notification with an ID already visible is ignored.
titlestring?localized by typeHeading. Omit it to use the localized type label.
descriptionstring?""Notification body.
typestring?"info"primary, inform, info, warning, error, or success.
durationnumber?3000Display duration in milliseconds.
iconstring?type iconFree Font Awesome icon name or classes.
colorstring?type colorCSS color for the accent and duration bar.
iconColorstring?colorCSS color for the notification icon.

When title is omitted, the resource uses notification_info, notification_warning, notification_err, or notification_success from the active locale.

Custom notification
exports['orbit-dynamichud-v2']:Notify({
    id = 'vehicle_locked',
    description = 'Vehicle locked.',
    type = 'inform',
    icon = 'fas fa-lock',
    color = '#71B6F7',
    iconColor = '#FFFFFF',
    duration = 2500
})

ox_lib drop-in replacement

Add this after @ox_lib/init.lua in the resource. Existing lib.notify(data) calls require no changes.

client/orbit_notify.lua
lib = lib or {}

lib.notify = function(data)
    return exports['orbit-dynamichud-v2']:notify(data)
end

Core ox_lib fields (id, title, description, duration, type, icon, and iconColor) map directly. DynamicHUD owns placement and styling, so ox_lib-only fields such as position, nested style, showDuration, and sound do not change the DynamicHUD notification presentation.

See the complete compatibility bridge when replacing all four interfaces.

On this page