Exports

This page explains how to register and execute commands and actions from external scripts using the terminal's built-in exports.

Client

addExternal(name,callback)

Use this export to register a custom callback. It triggers whenever the terminal processes an action with a matching callback value.

Parameters

• name:string Action name, should match the field callback from a server side action.

• callback: function(data) Callback to perform

Return

• success:boolean true will allow the command to execute the following actions, false will stop everything and print the failure action.

addSuccess(command, callback)

Use this export to register a onSuccess callback to trigger when a command is completed successfully.

Parameters

• command:string Must be an existing command.

• callback:function(data) Callback to perform

terminal(action)

Triggers an array of actions within the terminal, adhering to the format specified in Terminal

local actions = {
    {
        type = "text",
        input = "No vehicle found nearby.",
        style = "error",
        delay = 0
    }
}
exports['av_laptop']:terminal(actions)

Server

Keyfob Example

This example script registers the keyfob command to execute a sequence of actions, demonstrating how to:

• Trigger 3 custom client-side callbacks (demo:validate, demo:getClosest, and demo:processKeys).

• Use the userInput action type to pause the sequence and capture the vehicle's SSID.

• Reward the player with the vehicle keys once the entire action sequence is successfully completed.

client.lua

local temp_ids = {}
local temp_vehicle = nil

CreateThread(function()
    while not GetResourceState('av_laptop') == 'started' do
        Wait(100)
    end
    exports['av_laptop']:addExternal("demo:validate", validateInput)
    exports['av_laptop']:addExternal("demo:getClosest", getClosest)
    exports['av_laptop']:addExternal("demo:processKeys", processKeys)
end)

function getClosest()
    local data = {}
    local playerCoords = GetEntityCoords(cache.ped)
    local vehicles = lib.getNearbyVehicles(playerCoords, 10.0)
    for _, v in pairs(vehicles) do
        local veh = type(v) == "table" and (v.vehicle or v.entity) or v
        local plate = GetVehicleNumberPlateText(veh)
        local modelName = exports['av_laptop']:getVehicleName(GetEntityModel(veh))
        local distance = #(playerCoords - GetEntityCoords(veh))
        local cleanModel = string.gsub(modelName, "%s+", "")
        local ssid = string.format("%s_0x%03X", string.upper(string.sub(cleanModel, 1, 6)), math.random(256, 4095))
        temp_ids[ssid] = {
            vehicle = veh,
            plate = plate,
            model = modelName,
            ssid = ssid,
            distance = distance
        }
        table.insert(data, {
            plate,
            modelName,
            ssid,
            string.format("%.1fm", distance)
        })
    end
    if #data == 0 then
        exports['av_laptop']:terminal({
            {
                type = "text",
                input = "No vehicle found nearby.",
                style = "error",
                delay = 0
            }
        })
        return false
    end
    exports['av_laptop']:terminal({
        {
            type = "table",
            columns = {"PLATE", "MODEL", "SSID", "DISTANCE"},
            rows = data,
            delay = 0
        },
    })
    return true
end

function validateInput(args)
    if not args then return false end
    local targetSSID = args['extraData']
    if not targetSSID then
        print("No target ssid provided in args")
        return false
    end
    if temp_ids[targetSSID] then
        temp_vehicle = temp_ids[targetSSID] and temp_ids[targetSSID].vehicle or nil
        if not temp_vehicle then
            print("Vehicle associated with SSID not found, it might have been deleted or gone out of range")
            return false
        end
        local dist = #(GetEntityCoords(cache.ped) - GetEntityCoords(temp_vehicle))
        if dist > 11.0 then
            exports['av_laptop']:terminal({
                {
                    type = "text",
                    input = "Vehicle is too far away.",
                    style = "error",
                    delay = 0
                }
            })
            return false
        end
        return true
    else
        print("Provided SSID does not match any temporary IDs")
        return false
    end
end

function processKeys()
    print("processKeys() called, temp_vehicle:", temp_vehicle)
    if not temp_vehicle then
        print("No vehicle set for processing keys or it got deleted (?)")
        return false
    end
    local plate = GetVehicleNumberPlateText(temp_vehicle)
    TriggerEvent('qb-vehiclekeys:client:AddKeys', plate) -- default qb-vehiclekeys event for giving keys
    return true
end

server.lua

fxmanifest.lua