Commands and Exports — Interface | Quasar Store | Quasar Store

Commands and Exports — Interface | Quasar Store | Quasar Store

Commands#

Interface registers its keys as FiveM key bindings, so every player can rebind them in Settings → Key Bindings → FiveM. The names of the editor, reset, report and settings commands — and the default keys of the editor and the chat — are set in /interfaceconfig → Commands and keys; the tables below use the defaults.

Players#

Command	Default key	Description
`/hud` · `configure_hud`	F9

Command

Where

Description

/interfaceconfig

In game

Opens the server settings. Needs the command.interfaceconfig ace.

/chatadmin

In game

Opens the chat admin panel. Framework admins.

/a <message>

In game

Admin message, visible to everyone.

givevip <id> <tier> [days]

Game · console

Gives a VIP tag: vip, premium, elite, legend or immortal. No days = permanent.

removevip <id>

Game · console

Takes the VIP tag away.

refreshvip <id | license>

Game · console

Re-reads a tag from the database after you edited chat_vip_tags by hand.

qs_mapdebug

F8 console

Prints why the minimap frame is shown or hidden right now.

Command	Description
`/reset_hud_config`	Wipes your saved HUD; the first-time setup runs again on the next load.
`/notify` · `/progresstest`	A sample notification and a sample progress bar with props.
`/cinematic` · `/stopcinematic`	Starts and stops the orbiting camera.
`/close_configure_hud`	Restores the camera and minimap if the editor was left half-open.

AddNotify

Shows a notification in the player's chosen style. Every argument after the text is optional.

lua

exports['qs-interface']:AddNotify(text, header, time, icon)

-- Example
exports['qs-interface']:AddNotify('Your car is ready.', 'Garage', 5000, 'fas fa-car')
-- header defaults to 'Notification', time to 5000 ms, icon to 'fas fa-inbox'

The icon is any Font Awesome class. From the server, send the same notification with an event:

lua

TriggerClientEvent('interface:notification', source, 'Your car is ready.', 'Garage', 5000, 'fas fa-car')

ProgressBar

Runs a progress bar and waits for it. Returns true when it completes and false when it is cancelled or interrupted. progress is the same export under another name. The options follow ox_lib's, so most scripts port over unchanged.

lua

local done = exports['qs-interface']:ProgressBar({
    label = 'Repairing',
    duration = 5000,               -- ms
    canCancel = true,              -- X cancels it
    useWhileDead = false,          -- the allow* options default to false:
    allowRagdoll = false,          -- dying, ragdolling, falling, swimming
    allowFalling = false,          -- or being cuffed interrupts the bar
    allowSwimming = false,
    allowCuffed = false,
    disable = { move = true, sprint = true, car = true, combat = true, mouse = false },
    anim = { dict = 'mini@repair', clip = 'fixing_a_ped', flag = 49 },
    -- or: anim = { scenario = 'WORLD_HUMAN_WELDING' },
    prop = {                       -- one prop, or a list of them
        model = 'prop_tool_spanner01',
        bone = 60309,
        pos = vec3(0.0, 0.0, 0.0),
        rot = vec3(0.0, 0.0, 0.0),
    },
})

if done then
    -- finished
end

CancelProgress · ProgressActive

lua

exports['qs-interface']:CancelProgress()  -- true if a cancellable bar was stopped
exports['qs-interface']:ProgressActive()  -- true while a bar is running

-- From anywhere (client or server), the same as pressing X:
TriggerEvent('interface:cancelProgress')

ToggleHud

Shows or hides the status HUD, vehicle HUD, info displayer, minimap and compass. Notifications and progress bars keep working.

lua

exports['qs-interface']:ToggleHud(false) -- hide, e.g. for a cutscene
exports['qs-interface']:ToggleHud(true)  -- show again

Initialize · HasHudConfigured

Initialize starts the Interface — the first-time setup or the HUD. It runs on its own on the framework's player-loaded event and with qs-multicharacter; call it from a multicharacter that spawns the player some other way.

lua

exports['qs-interface']:Initialize()

-- Waits until the Interface knows, then returns true once the player
-- has finished the first-time setup:
local configured = exports['qs-interface']:HasHudConfigured()

SetMapBorderVisible

Forces the minimap frame — and the 3D minimap — on or off, for a script that hides or shows the radar itself. nil hands control back.

lua

exports['qs-interface']:SetMapBorderVisible(false)
exports['qs-interface']:SetMapBorderVisible(nil)

RefreshMinimap

Applies the player's saved minimap shape again — circle, square or 3D. Interface already does it on its own after the player spawns and after the ESX, QBCore and Qbox player-loaded events; call it when another script has reset or moved the radar, for example after a cutscene, a custom spawn or a teleport.

lua

exports['qs-interface']:RefreshMinimap()

The first pass runs right away and two more follow a few seconds later while the HUD settles; a new call replaces one still running. Nothing happens while the player has the HUD editor open.

Client events

Events Interface fires that your scripts can listen to:

lua

AddEventHandler('interface:vehicleEntered', function(vehicle) end)
AddEventHandler('interface:vehicleLeft', function() end)
AddEventHandler('interface:gameScreenReady', function() end)      -- HUD on screen
AddEventHandler('seatbelt:client:ToggleSeatbelt', function(on) end)
AddEventHandler('qs-interface:settingsApplied', function() end)   -- /interfaceconfig values changed (client and server)

refreshVip

Re-reads a VIP tag from chat_vip_tags and updates the badge immediately. Call it after your own INSERT, UPDATE or DELETE — tags are otherwise cached for up to an hour. Accepts a server ID or a license: identifier; returns true if an online player was reloaded.

lua

exports['qs-interface']:refreshVip('license:1a2b3c...')

-- or, without depending on the export:
TriggerEvent('qs-interface:chatvip:refresh', 'license:1a2b3c...')

getPlayerVipTag · getVipTiers

lua

local tag = exports['qs-interface']:getPlayerVipTag(source)
-- nil, or { id, label, nameColor, tagColor, tagGradient, glowColor, animation }

local tiers = exports['qs-interface']:getVipTiers()
-- the five tiers, in order

isCommandEnabled · getChatAdminSettings

Read what staff set in the chat admin panel.

lua

exports['qs-interface']:isCommandEnabled('ooc') -- me, do, ooc, anon, admin, report, dice, rps, pm
exports['qs-interface']:getChatAdminSettings()   -- { commands, badwords, draw3d, jobchannels, categorytabs, ... }

checkFloodProtection

Applies the chat's anti-spam rules to your own chat command. Returns false — and tells the player — when the message should be dropped.

lua

RegisterCommand('twt', function(source, args)
    if not exports['qs-interface']:checkFloodProtection(source) then return end
    -- ...
end)

Stress events

Compatible with the events qb-hud uses, so scripts written for it work unchanged. Sent from the client:

lua

TriggerServerEvent('hud:server:GainStress', 5)     -- needs stress switched on, skips jobs without stress
TriggerServerEvent('hud:server:RelieveStress', 10)  -- always applies

lua

-- client or server, the classic events
TriggerClientEvent('chat:addMessage', -1, { args = { 'SYSTEM', 'Restart in 5 minutes' } })
TriggerEvent('chat:addSuggestion', '/mycmd', 'What it does', { { name = 'id', help = 'Player ID' } })
TriggerEvent('chat:removeSuggestion', '/mycmd')

-- server exports
exports['qs-chat']:addMessage(target, message)
exports['qs-chat']:registerMessageHook(function(source, outMessage, hookRef) end)
exports['qs-chat']:registerMode({ name = 'police', displayName = 'Police', color = '#3b82f6', seObject = 'group.police', cb = function() end })