Developers

Every export is called on exports.lation_laundering. 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.

Client exportsCopy Anchor Link

OpenMenuCopy Anchor Link

exports.lation_laundering:OpenMenu()

Opens the main menu wherever the player is, after CanOpenMenu and the item Config.Start.require asks for. Use it with Config.Start.spawnPed = false to start runs from your own NPC, item or phone app. It waits for the server, so call it from a thread, a command or an event handler.

Contracts start from anywhere. The contract car spawns at the nearest Config.Vehicle.locations entry, and with teleport on the player is put in it there. The car deposit, its refund and the warehouse key are only handled within 15 m of a Config.Start.locations entry, so list the places you open it from there; elsewhere the car is handed out without its deposit, and buying a key does nothing.

RegisterCommand('launder', function()
    exports.lation_laundering:OpenMenu()
end, false)

IsLaunderingCopy Anchor Link

local running = exports.lation_laundering:IsLaundering()

It goes false for a moment at the end of each deal, before the next buyer is marked, and stays false once the run stops.

GetData (client)Copy Anchor Link

local data = exports.lation_laundering:GetData(type)

It asks the server, so call it from a thread.

CreateThread(function()
    local level = exports.lation_laundering:GetData('level')
    print(('Laundering level %d'):format(level))
end)

GetBalanceCopy Anchor Link

local amount = exports.lation_laundering:GetBalance(moneyType)

It asks the server, so call it from a thread.

PoliceCountCopy Anchor Link

local police = exports.lation_laundering:PoliceCount()

GetTimeRemainingCopy Anchor Link

local hours, minutes, seconds = exports.lation_laundering:GetTimeRemaining()

local h, m, s = exports.lation_laundering:GetTimeRemaining()
if h + m + s > 0 then
    print(('Wash ready in %dh %dm %ds'):format(h, m, s))
end

Server exportsCopy Anchor Link

GetDataCopy Anchor Link

local data = exports.lation_laundering:GetData(source, type)

The first time a player is looked up, their row is read from the lation_laundering table, or created at level 1. The record is the cached one, kept in memory until they leave, so treat it as read-only and change it with AddData. At the last level, experience reads as Config.LevelUp.

{
    player_identifier = 'ABC12345', -- once read from the database
    level = 3,
    experience = 42000,           -- XP earned at the current level
    contracts_completed = 318,
    total_money_cleaned = 412750, -- dirty money laundered, lifetime
    pending = 0,                  -- dirty money in the washing machine
    time_remaining = 0,           -- milliseconds left on that wash
}

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

AddDataCopy Anchor Link

exports.lation_laundering:AddData(source, amount, dataType, action)

Changes the cached record. XP is refused at the last level. Adding XP doesn't level the player up on its own: call CheckLevel after it. Nothing is written straight away; the record is saved when the player leaves, when the resource stops and when txAdmin shuts the server down.

exports.lation_laundering:AddData(source, 5000, 'experience', 'add')
exports.lation_laundering:CheckLevel(source)

CheckLevelCopy Anchor Link

exports.lation_laundering:CheckLevel(source)

Moves the player up a level for every Config.LevelUp of XP they hold, keeps the leftover, and sends the levelUp log. Does nothing at the last level. The player isn't told, and the warehouse blip waits for their next login or a key.

IsLaundering (server)Copy Anchor Link

local running = exports.lation_laundering:IsLaundering(source)

It asks the player's client and waits for the answer, so call it from a thread or an event handler.

EventsCopy Anchor Link

lation_laundering:NotifyCopy Anchor Link

TriggerClientEvent('lation_laundering:Notify', source, message, type)

Send it from the server to show a notification through Config.Notify, under the script's Money Laundering title where the system shows one.

TriggerClientEvent('lation_laundering:Notify', source, 'The launderer wants a word', 'inform')

HooksCopy Anchor Link

Hooks are plain functions in the files that ship open. Edit them in place.

Client hooksCopy Anchor Link

In client/functions.lua.

CanOpenMenuCopy Anchor Link

CanOpenMenu = function() end

Tell the player why when you refuse, with ShowNotification(message, 'error').

CanBuyKeyCopy Anchor Link

CanBuyKey = function() end

The file's example keeps keys to gang members, with a placeholder that lets everyone through:

CanBuyKey = function()
    local inGang = true -- replace with your gang script's check
    if not inGang then
        ShowNotification('You must be a gang member to purchase this', 'error')
        return false
    end
    return true
end

CanEnterWarehouseCopy Anchor Link

CanEnterWarehouse = function() end

The default is the warehouse's whole entry check: the player needs Config.Items.key and, with Config.Warehouse.requireLvl, the unlock level; police jobs need neither while Config.Police.warehouseAccess is on. A refused player is told "You are not authorized to enter". Add your own conditions before its return, and keep the rest unless you mean to replace it.

Server hooksCopy Anchor Link

In server/functions.lua. Both run before the money moves.

function TaxPaid(source, amount, type)
    -- the tax goes to a job's account in lation banking
    exports.lation_banking:AddAccountMoney('government', amount, 'Laundering tax')
end

IntegrationsCopy Anchor Link

Each system the config lets you pick is a function in client/functions.lua, with a branch to fill in for 'custom':

Frameworks live in bridge/client.lua and bridge/server.lua: each function has a branch marked for a custom framework.