ox_lib quick reference

shared_script '@ox_lib/init.lua'

Load ox_lib in your resource. This gives you the lib, cache and require globals.

-- fxmanifest.lua
fx_version 'cerulean'
game 'gta5'
lua54 'yes'

shared_script '@ox_lib/init.lua'
server_script '@oxmysql/lib/MySQL.lua' -- only if you use the MySQL global

ox_lib needs lua54 'yes'. Start ox_lib before your resource in server.cfg.

lib.notify(data)

Show a notification on the client. type is info, success, warning or error.

-- client
lib.notify({
    title = 'Vehicle stored',
    description = 'Your car is in the garage.',
    type = 'success',
    duration = 5000,
    position = 'top-right',
})

-- server: send it to one player
TriggerClientEvent('ox_lib:notify', source, {
    description = 'Welcome back',
    type = 'info',
})

lib.notify(playerId, data) on the server is deprecated in ox_lib. 'inform' is an old v3 name; the current types are info, success, warning and error.

lib.registerContext(context) + lib.showContext(id)

Build a context menu, then open it. Registering it does not open it.

lib.registerContext({
    id = 'garage_menu',
    title = 'Garage',
    options = {
        {
            title = 'Spawn vehicle',
            icon = 'car',
            onSelect = function()
                TriggerServerEvent('garage:spawn')
            end,
        },
    },
})

lib.showContext('garage_menu')

Give a submenu menu = 'parent_id' to get a back button to the parent.

lib.callback.register / lib.callback.await

Ask the other side for a value and wait for the answer. Works in both directions.

-- server
lib.callback.register('bank:getBalance', function(source, account)
    return GetBalance(source, account)
end)

-- client: the 2nd argument is a delay in ms or false, not a player id
local balance = lib.callback.await('bank:getBalance', false, 'checking')

-- server asking a client: here the 2nd argument is the player id
local coords = lib.callback.await('myres:getCoords', source)

lib.skillCheck(difficulty, inputs)

Blocking skill check. Returns true on success, false on fail. Difficulty is 'easy', 'medium', 'hard' or { areaSize, speedMultiplier }.

local success = lib.skillCheck({ 'easy', 'easy', 'hard' }, { 'w', 'a', 's', 'd' })

if success then
    -- player passed every check
end

lib.progressBar(data) / lib.progressCircle(data)

Blocking progress with optional animation and prop. Returns true when finished, false when cancelled.

if lib.progressBar({
    duration = 5000,
    label = 'Repairing',
    canCancel = true,
    disable = { car = true, move = true, combat = true },
    anim = { dict = 'mini@repair', clip = 'fixing_a_ped' },
}) then
    -- finished
else
    -- cancelled
end

lib.inputDialog(heading, rows, options)

Form dialog. Returns an array of values in row order, or nil if the player closed it.

local input = lib.inputDialog('Transfer money', {
    { type = 'number', label = 'Amount', min = 1, required = true },
    { type = 'input', label = 'Note' },
})

if not input then return end
local amount, note = input[1], input[2]

lib.alertDialog(data, timeout)

Confirm dialog. Returns 'confirm', 'cancel' or nil.

local answer = lib.alertDialog({
    header = 'Sell vehicle?',
    content = 'You get $12,000. This cannot be undone.',
    centered = true,
    cancel = true,
})

if answer == 'confirm' then
    TriggerServerEvent('dealer:sell')
end

MySQL.query.await / single / scalar / insert (oxmysql)

Awaitable oxmysql queries: many rows, one row, one value, or an insert id.

-- server, with server_script '@oxmysql/lib/MySQL.lua' in the fxmanifest
local rows     = MySQL.query.await('SELECT * FROM vehicles WHERE owner = ?', { owner })
local row      = MySQL.single.await('SELECT * FROM users WHERE identifier = ?', { identifier })
local name     = MySQL.scalar.await('SELECT name FROM users WHERE id = ?', { id })
local insertId = MySQL.insert.await('INSERT INTO logs (msg) VALUES (?)', { msg })

Without the MySQL global, the matching exports are exports.oxmysql:query_async and friends. There is no query_await export. fetchAll, fetchScalar and execute are legacy aliases.