Developers

Every export is called on exports.lation_chopshop. Server exports that act on a player take their server id as source; client exports work on the local player. A player's identifier is the ESX identifier on ESX and the citizenid on Qbox and QBCore.

Server exportsCopy Anchor Link

getPlayerDataCopy Anchor Link

exports.lation_chopshop:getPlayerData(source, type)

The first time a player is looked up, a record is created at level 1. A player whose stored level no longer fits the level ladder is moved to the level their XP reaches as they are looked up. The record is the cached one, so treat it as read-only and change it with addPlayerData.

{
    identifier = 'ABC12345',
    name = 'Jane Doe',     -- character name
    level = 3,
    exp = 12450,           -- total XP
    vehicles = 18,         -- vehicles chopped
    parts = 214,           -- parts received
}

local level = exports.lation_chopshop:getPlayerData(source, 'level')
if level and level >= 3 then
    -- unlock something
end

addPlayerDataCopy Anchor Link

exports.lation_chopshop:addPlayerData(source, dataType, amount)

Adding exp levels the player up past each threshold they cross and sends the level up notice (and the level_up log when it is on). Nothing is written straight away: the record is saved when the player leaves or logs out of the character, every 5 minutes while it has changes, when the resource stops and when txAdmin shuts the server down.

exports.lation_chopshop:addPlayerData(source, 'exp', 250)

getLevelDataCopy Anchor Link

exports.lation_chopshop:getLevelData()

local levels = exports.lation_chopshop:getLevelData()
-- { [1] = 0, [2] = 5000, [3] = 10000, [4] = 25000, [5] = 75000 }

getContractCopy Anchor Link

exports.lation_chopshop:getContract(source)

{
    tierId = 'street',       -- the tier's key
    vehicleClass = 1,        -- the class id it asks for (see vehicle class ids)
    cashBonus = 500,         -- paid when the car is finished in time
    issuedAt = 1730000000,   -- unix time
    expiresAt = 1730003600,  -- unix time the timer runs out
    bonusEligible = true,    -- false once the time has run out
    activeNetId = nil,       -- net id of the car being chopped on it
}

The class ids are in vehicle class ids.

local contract = exports.lation_chopshop:getContract(source)
if contract and contract.bonusEligible then
    print(('%d seconds left'):format(contract.expiresAt - os.time()))
end

getContractDetailsCopy Anchor Link

exports.lation_chopshop:getContractDetails(source)

{
    status = 'active',            -- 'active', 'in_progress' (a car is being chopped), 'expired' or 'none'
    tierId = 'suv',
    tierLabel = 'SUV',
    vehicleClass = 2,
    vehicleClassLabel = 'SUVs',   -- in the server's language
    issuedAt = 1730000000,
    expiresAt = 1730004500,
    remainingSeconds = 4455,      -- 0 once it has run out
    cashBonus = 750,
    bonusEligible = true,
    activeNetId = nil,
    canCancel = true,             -- the Allow cancelling setting
    cooldownMinutes = 0,          -- the Completion cooldown setting
    account = 'cash',             -- the bonus payout account
    accountIsMoney = true,        -- true for cash, bank or money; false for an item
}

local details = exports.lation_chopshop:getContractDetails(source)
if details.status == 'active' then
    print(details.tierLabel, details.vehicleClassLabel, details.remainingSeconds)
end

issueContractCopy Anchor Link

exports.lation_chopshop:issueContract(source)

Gives the player a contract and its paper, with the same checks as Request Contract at the broker: their job (through CanRequestJob), the cooldown, a contract already running, the police count, a tier at their level and room for the paper. The player is told when it is refused. There is no distance check, so you can hand out contracts from your own NPC or job. Call getContract afterwards to see whether one was issued.

RegisterNetEvent('my_resource:takeChopJob', function()
    local src = source
    exports.lation_chopshop:issueContract(src)
end)

GetRuntimeConfigCopy Anchor Link

exports.lation_chopshop:GetRuntimeConfig(section)

The table is the live configuration: changes you make to it aren't saved, so change settings in the admin panel.

local contracts = exports.lation_chopshop:GetRuntimeConfig('contracts')
print(contracts.account, contracts.completionCooldown)

Client exportsCopy Anchor Link

getPlayerData (client)Copy Anchor Link

exports.lation_chopshop:getPlayerData(type)

It waits for the server, so call it from a thread.

CreateThread(function()
    local data = exports.lation_chopshop:getPlayerData()
    print(('Level %s with %s XP'):format(data.level, data.exp))
end)

getLevelData (client)Copy Anchor Link

exports.lation_chopshop:getLevelData()

hasActiveContractCopy Anchor Link

exports.lation_chopshop:hasActiveContract()

It asks the server, so call it from a thread. A contract that has run out is cleared by the check, paper included.

CreateThread(function()
    if exports.lation_chopshop:hasActiveContract() then
        -- show a hint
    end
end)

openMenuCopy Anchor Link

exports.lation_chopshop:openMenu()

Opens the broker menu wherever the player is. A player with a blacklisted job gets the job notice instead. Contracts can be requested from it anywhere, but the shops still need the player within 15 m of a broker.

RegisterCommand('chopmenu', function()
    exports.lation_chopshop:openMenu()
end, false)

EventsCopy Anchor Link

lation_chopshop:configUpdatedCopy Anchor Link

AddEventHandler('lation_chopshop:configUpdated', function(config) end)

Fires on the server after the settings load on start, and again after every save, reset or import in the admin panel. It is a local server event: listen with AddEventHandler in a server script.

AddEventHandler('lation_chopshop:configUpdated', function(config)
    print(('Contract bonuses pay into %s'):format(config.contracts.account))
end)

lation_chopshop:runtimeReadyCopy Anchor Link

AddEventHandler('lation_chopshop:runtimeReady', function() end)

Fires on the client each time the settings reach it: after joining, after a restart of the resource, and after every save, reset or import in the admin panel. It carries no arguments; use it to refresh anything of your own that follows chop shop settings. The client never receives the logs section.

AddEventHandler('lation_chopshop:runtimeReady', function()
    print('chop shop settings are in')
end)

lation_chopshop:notifyCopy Anchor Link

TriggerClientEvent('lation_chopshop:notify', source, message, notifyType)

Send it from the server to show a notification through the system set under Setup > Notifications.

TriggerClientEvent('lation_chopshop:notify', source, 'The broker has a job for you', 'inform')

HooksCopy Anchor Link

Hooks are plain functions in files that ship open. Edit them in place to change who can do what. Every server hook below is called, so a hooks file kept from an older version must still define each of them.

Server hooksCopy Anchor Link

In lua/server/utils/hooks.lua.

CanDoChoppingCopy Anchor Link

function Hooks.CanDoChopping(source, notify) end

Called before a player starts a chop, starts or finishes taking a part off, and inside the default CanRequestJob and CanParticipate. By default it refuses blacklisted jobs.

CanRequestJobCopy Anchor Link

function Hooks.CanRequestJob(source) end

Called when a contract is requested, at the broker or through issueContract. By default it calls CanDoChopping with notify on.

function Hooks.CanRequestJob(source)
    if not source then return false end
    -- add your own check here, return false to refuse
    return Hooks.CanDoChopping(source, true)
end

CanChopVehicleCopy Anchor Link

function Hooks.CanChopVehicle(source, entity) end

The server's say on a car when a chop starts, after its own checks have passed: the player's contract and its class, the distance, the chop location and the blacklisted models. The client's CanStartChopping asks first, so an honest player hears no early, but this is the answer that counts. A refusal tells the player nothing on its own, so send your own notice, as the default does.

By default, while Allow owned vehicles is off, it refuses a car whose plate is in the owned vehicles table, whoever owns it. The lookup is one query by plate, kept for a minute (IsPlayerOwnedVehicle in lua/server/utils/vehicles.lua).

function Hooks.CanChopVehicle(source, entity)
    -- Never take a car out of the police impound lot
    if #(GetEntityCoords(entity) - vector3(409.0, -1623.0, 29.3)) < 40.0 then
        TriggerClientEvent('lation_chopshop:notify', source, 'Not from the impound lot', 'error')
        return false
    end

    if not runtime.start.allowOwned then
        if IsPlayerOwnedVehicle(GetVehicleNumberPlateText(entity)) then
            TriggerClientEvent('lation_chopshop:notify', source, locale('notify.owned-vehicle'), 'error')
            return false
        end
    end

    return true
end

CanParticipateCopy Anchor Link

function Hooks.CanParticipate(source, netId) end

Called before placing or removing stands, raising or lowering the car, opening the hood, starting or finishing a part, and breaking the drill. By default it is true when the player passes CanDoChopping and is within 30 m of the car (of any car being chopped, when netId is nil). Each of those actions, except breaking the drill, also needs the player within 12 m of the car's center, which the server checks on its own after the hook.

VehiclePartRemovedCopy Anchor Link

function Hooks.VehiclePartRemoved(source, entity, model, typeId, partId) end

Called after a part is credited to a player. Does nothing by default.

function Hooks.VehiclePartRemoved(source, entity, model, typeId, partId)
    if partId == 'engine_turbo' then
        -- give a rare bonus item
    end
end

Client hooksCopy Anchor Link

In lua/client/utils/hooks.lua.

CanStartChoppingCopy Anchor Link

function Hooks.CanStartChopping(model, entity) end

Called when the player picks Start chopping, before the server is asked. By default it refuses blacklisted jobs with a notice and, while Allow owned vehicles is off, a car whose plate is in the owned vehicles table. It only decides what an honest player is told first: the server asks again in CanChopVehicle, and that answer counts.

StartedChoppingCopy Anchor Link

function Hooks.StartedChopping(entity, model) end

Called once the server has opened the chop on that car. Does nothing by default.

function Hooks.StartedChopping(entity, model)
    -- tell your own dispatch script where the car is
    TriggerServerEvent('my_dispatch:chopStarted', NetworkGetNetworkIdFromEntity(entity))
end

The hooks files also define Hooks.GetContract and Hooks.IsInitiator (server) and Hooks.CanInteractWithVehiclePart (client). Nothing calls them, so editing them changes nothing.

Open filesCopy Anchor Link

The files that ship open, so you can read and change them: