Commands and Exports — Text UI for FiveM | Quasar Store

Commands and Exports — Text UI for FiveM | Quasar Store | Quasar Store

Commands#

Text UI registers no chat or console commands. Prompts are created by your scripts through the exports below, or placed in shared/config.lua — see Usage.

Client Exports#

Every export is client-side. To show a prompt from the server, trigger a client event of your own and call the export there.

Export	Does
`displayTextUI`	Shows the on-screen prompt.

On-screen prompt — displayTextUI, changeText, hideTextUI

lua

-- displayTextUI(text, key?, align?)
exports['qs-textui']:displayTextUI('Open the garage', 'E', 'center-right')

-- changeText(text, key?) — new text without sliding in again
exports['qs-textui']:changeText('Close the garage', 'E')

exports['qs-textui']:hideTextUI()

Parameter	Default	Meaning
`text`	—	The text. GTA codes and HTML allowed.
`key`	`Config.DefaultKey`	The label on the badge. Display only — your script handles the keypress.
`align`	`Config.DefaultAlign`	One of the nine screen positions. An unknown value falls back to the default.

There is one on-screen prompt at a time: a second displayTextUI replaces the first. Show it when the player enters the zone and hide it when they leave — not on every frame:

lua

local garage = vector3(215.8, -810.1, 30.7)
local shown = false

CreateThread(function()
    while true do
        local near = #(GetEntityCoords(PlayerPedId()) - garage) < 3.0
        if near and not shown then
            exports['qs-textui']:displayTextUI('Open the garage', 'E')
            shown = true
        elseif not near and shown then
            exports['qs-textui']:hideTextUI()
            shown = false
        end
        if near and IsControlJustReleased(0, 38) then
            -- open your garage here
        end
        Wait(near and 0 or 500)
    end
end)

3D text at a coordinate — create3DTextUI, update3DTextUI, DeleteDrawText3D

A prompt floating over a point, with its own distances and an event fired when its key is pressed. Call it once — when your script starts, or when the thing it points at appears — not in a loop.

lua

exports['qs-textui']:create3DTextUI('pd_duty', {
    coords = vector3(441.8, -982.1, 30.7),
    displayDist = 8.0,
    interactDist = 2.0,
    enableKeyClick = true,
    keyNum = 38,
    key = 'E',
    text = 'Go on duty',
    job = 'police',
    canInteract = function()
        return not IsPedInAnyVehicle(PlayerPedId(), false)
    end,
    triggerData = {
        triggerName = 'my-police:server:toggleDuty',
        args = { station = 'mrpd' },
        isServer = true
    },
    invokingResource = GetCurrentResourceName()
})

exports['qs-textui']:update3DTextUI('pd_duty', 'Go off duty')
exports['qs-textui']:DeleteDrawText3D('pd_duty')

Quick 3D label — drawText3D

lua

-- drawText3D(x, y, z, text, id, key)
exports['qs-textui']:drawText3D(100.0, 200.0, 30.0, 'Warehouse', 'warehouse_label', 'E')

exports['qs-textui']:DeleteDrawText3D('warehouse_label')

A display-only label with fixed distances — a marker from 5 m, the text from 2 m — and no keypress of its own: the calling script checks the key itself. Calling it again with the same id moves the label and updates its text, so it is safe to call on every frame. It is what the DrawText3D wrapper uses.

Labels from drawText3D belong to the resource that created them and are removed when it stops. The same call is available as a client event:

lua

3D text on a player — create3DTextUIOnPlayers, DeleteDrawText3DOnPlayers

A prompt that floats over another player and follows them. It takes a second key and a second event, for two actions on the same person:

lua

local promptId = 'cuffed_' .. targetServerId

exports['qs-textui']:create3DTextUIOnPlayers(promptId, {
    id = targetServerId,            -- server id of the player to follow
    displayDist = 6.0,
    interactDist = 2.0,
    enableKeyClick = true,
    key = 'E',
    text = 'Search · ~c~[G] Escort',
    keyNum = 38,
    triggerData = {
        triggerName = 'my-police:client:search',
        args = { target = targetServerId }
    },
    keyNum2 = 47,
    triggerData2 = {
        triggerName = 'my-police:client:escort',
        args = { target = targetServerId }
    }
})

exports['qs-textui']:DeleteDrawText3DOnPlayers(promptId)

lua

local function createPrompts()
    exports['qs-textui']:create3DTextUI('pd_duty', { --[[ ... ]] })
end

CreateThread(createPrompts)

AddEventHandler('onClientResourceStart', function(resource)
    if resource == 'qs-textui' then
        createPrompts()
    end
end)

Field	Required	Meaning
`coords`	Yes	A `vector3` — where the prompt floats.
`displayDist`	Yes	Distance at which the marker appears.
`interactDist`	Yes	Distance at which the text shows and the key works.
`key`	Yes	The label on the badge — also for a prompt with no key.
`text`	Yes	The text. GTA codes and HTML allowed.
`keyNum`	No	Control id of the key (38 = E). Without it, the prompt only informs.
`enableKeyClick`	No	Leave it `true`. On a 3D prompt the key is active whenever `keyNum` is set.
`triggerData`	No	The event fired on the keypress: `triggerName`, `args` (received as one table) and `isServer` — `true` sends it to the server instead of the client.
`job`	No	`'all'` (default) or a job name. Needs a framework.
`canInteract`	No	A function. Return `false` to hide the prompt.
`invokingResource`	No	A resource name. When that resource stops, the prompt is removed. Pass `GetCurrentResourceName()`.

TriggerEvent('textui:DrawText3D', x, y, z, text, id, key)

Field	Meaning
`id`	Server id of the player the prompt follows.
`enableKeyClick`	Must be `true` for either key to work on a player prompt.
`keyNum` · `triggerData`	The first key and its event.
`keyNum2` · `triggerData2`	Optional second key and its event.
`displayDist` · `interactDist` · `key` · `text`	As in `create3DTextUI`.

Commands#

Client Exports#

When qs-textui Restarts#