Developers

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

GetDataCopy Anchor Link

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

The first time a player is looked up, their row is read from the lation_selling table, or created at level 1. The record is the cached one, so treat it as read-only and change it with AddData.

{
    level = 2,
    rep = 4120,            -- earned since the last level up; held at levelUp at the top level
    total_sales = 318,     -- drugs sold, all time
    total_earned = 52440,  -- money made, all time
    identifier = 'ABC12345', -- present once the record has come from the table
}

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

AddDataCopy Anchor Link

exports.lation_selling:AddData(source, amount, dataType)

Adding rep doesn't level the player up on its own: call CheckLevel after it. At the top level, rep can't be added. Nothing is written straight away: records are saved when the player leaves, when the resource stops and when txAdmin shuts the server down.

exports.lation_selling:AddData(source, 500, 'rep')
exports.lation_selling:CheckLevel(source)

CheckLevelCopy Anchor Link

exports.lation_selling:CheckLevel(source)

If the player's rep has reached Config.Reputation.levelUp, raises their level by as many levels as it covers, keeps the rest as rep, shows "Congratulations, you've leveled up!" and writes the leveled log when it's on. Does nothing at the top level. Every sale calls it.

PoliceCountCopy Anchor Link

local police = exports.lation_selling:PoliceCount()

This is GetPoliceCount in server/functions.lua, so a change there changes the export too.

TotalSalesCopy Anchor Link

local sold = exports.lation_selling:TotalSales(source, zoneId)

Sales are only counted in zones with limit on, toward their cap. In any other zone it stays 0.

Client exportsCopy Anchor Link

All three ask the server, so call them from a thread, not every frame.

GetData (client)Copy Anchor Link

local data = exports.lation_selling:GetData(type)

local level = exports.lation_selling:GetData('level')

PoliceCount (client)Copy Anchor Link

local police = exports.lation_selling:PoliceCount()

TotalSales (client)Copy Anchor Link

local sold = exports.lation_selling:TotalSales(zoneId)

EventsCopy Anchor Link

lation_selling:NotifyCopy Anchor Link

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

Send it from the server to show a notification through Config.Setup.notify, titled "Drugs".

TriggerClientEvent('lation_selling:Notify', source, 'A new buyer is asking around Vespucci', 'inform')

State bagCopy Anchor Link

drugSaleCopy Anchor Link

local state = Entity(ped).state.drugSale

Set by the server and seen by every client. A ped that is pending or sold can't be sold to, by anyone. Your own scripts can read it, for example to skip peds that have already dealt.

Server functionsCopy Anchor Link

server/functions.lua ships open. drug sales calls these functions by name, so keep each one defined with the same arguments when you edit it.

DrugSoldCopy Anchor Link

function DrugSold(source, zoneId, item, quantity, value, xpAdded, metadata) end

Called after every completed sale, once the item is taken and the seller is paid. It ships with an example for a gang script that does nothing until you edit it.

function DrugSold(source, zoneId, item, quantity, value, xpAdded, metadata)
    if metadata and metadata.purity == 100 then
        -- a perfect batch: reward it in your own script
        TriggerEvent('my_gangs:addRespect', source, 10 * quantity)
    end
end

(my_gangs:addRespect stands for your own script's event.)

ItemsClaimedCopy Anchor Link

function ItemsClaimed(source, item, quantity) end

Called when a player takes back drugs a buyer robbed them of. Empty by default.

CreateSaleQuoteCopy Anchor Link

function CreateSaleQuote(source, zoneId, item, itemCount) end

Works out each drug's offer when the menu opens, as described under prices: the purity or the zone's range, the police risk, the level's boost and the quantity. The server keeps the quote and pays its total if the sale goes through.

{
    price = 120,            -- one, before bonuses ("Buyer will buy for")
    difference = 18,        -- what police risk adds to one ("Risk bonus")
    unitPrice = 144,        -- one, with both bonuses
    quantity = 1,           -- "Buyer wants a total of"
    total = 144,            -- "Total sale is worth", what is paid
    missingMetadata = false, -- true when a Config.Metadata item had no value
}

PayPlayerCopy Anchor Link

function PayPlayer(source, zoneId, item, amount) end

Pays the zone's money, as described under money. Edit it to pay another way, for example into a gang's account.

GetPoliceCountCopy Anchor Link

function GetPoliceCount() end

Used for police risk, for zones that need police, and by the PoliceCount exports.

GetMetadataCopy Anchor Link

function GetMetadata(source, item) end

Reads purity for purity pricing, and keeps a robbed item's metadata so it comes back the same.

PlayerLogCopy Anchor Link

function PlayerLog(source, title, message) end

Sends a log to the service in Logs.Service. See logs.

Client functionsCopy Anchor Link

client/functions.lua ships open too. The ones you're most likely to edit:

CanSellCopy Anchor Link

function CanSell(zoneId) end

Asked each time a player starts a sale, before the menu opens. By default it stops a player in a vehicle with "You cannot sell from inside your vehicle".

function CanSell(zoneId)
    if IsPedInAnyVehicle(cache.ped, true) then
        ShowNotification(Strings.Notify.noVehicle, 'error')
        return false
    end
    -- Rockford Hills (zone 6) only deals with players carrying a burner phone (ox_inventory)
    if zoneId == 6 and exports.ox_inventory:Search('count', 'burner_phone') < 1 then
        ShowNotification('Nobody here trusts you without a burner', 'error') 
        return false
    end
    return true
end

PoliceDispatchCopy Anchor Link

function PoliceDispatch(data) end

Sends the police alert for the dispatch in Config.Setup.dispatch. Add yours under the custom branch; see dispatch.

The restCopy Anchor Link

Open filesCopy Anchor Link