Developers

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

local data = exports.lation_detecting:GetPlayerData(source, type)

The first time a player is looked up, a row is made for them at level 1. The record is the cached one, so treat it as read-only and change it with AddPlayerData. A record read from the database also carries identifier.

{
    level = 3,
    experience = 35500,   -- total XP
    items_found = 412,    -- items dug up
    money_earned = 58915, -- paid by the sell shop
}

local level = exports.lation_detecting:GetPlayerData(source, 'level')
if level and level >= 3 then
    -- the player can use the Treasure Trove Tracker
end

AddPlayerDataCopy Anchor Link

exports.lation_detecting:AddPlayerData(source, dataType, amount)

Adding experience levels the player up past each threshold they cross, shows You just leveled up in metal detecting! and writes the level_up log when it is on. XP stops at the last level's. There is no way to take XP away, and a level added directly is replaced by the level their XP reaches at their next XP gain, so give XP instead.

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_detecting:AddPlayerData(source, 'experience', 500)

GetLevelDataCopy Anchor Link

local levels = exports.lation_detecting:GetLevelData()

{ [1] = 0, [2] = 12500, [3] = 25000, [4] = 50000, [5] = 100000 }

Client exportsCopy Anchor Link

OpenMenuCopy Anchor Link

exports.lation_detecting:OpenMenu()

Opens the stats menu, as /metaldetecting does: Current Level, Current Progress, Items Found and Money Earned.

GetPlayerData (client)Copy Anchor Link

local data = exports.lation_detecting:GetPlayerData(type)

It asks the server and waits for the answer, so call it inside a thread or an event handler.

CreateThread(function()
    local found = exports.lation_detecting:GetPlayerData('items_found')
    print(('You have dug up %s items'):format(found or 0))
end)

GetLevelData (client)Copy Anchor Link

local levels = exports.lation_detecting:GetLevelData()

OpenDetectorShopCopy Anchor Link

exports.lation_detecting:OpenDetectorShop()

OpenSellShopCopy Anchor Link

exports.lation_detecting:OpenSellShop()

Both open the shop's menu wherever the player is: buying and selling don't check the distance to the shopkeeper, so you can put a shop on your own ped, prop or place. The job requirement still applies, and the server still checks every purchase and sale against the player's money and items.

exports.ox_target:addModel('a_m_m_beach_01', {
    {
        name = 'md_sell',
        label = 'Sell finds',
        icon = 'fas fa-sack-dollar',
        onSelect = function()
            exports.lation_detecting:OpenSellShop()
        end,
    },
})

EventsCopy Anchor Link

lation_detecting:NotifyCopy Anchor Link

TriggerClientEvent('lation_detecting:Notify', source, message, notifyType)

Send it from the server to show a notification through the system set in Config.Setup.notify, titled Metal Detecting.

TriggerClientEvent('lation_detecting:Notify', source, 'The beach closes at sunset', 'info')

The script's other events carry its own steps between client and server (lation_detecting:UseDetector, lation_detecting:ItemAssigned, lation_detecting:UseShovel, lation_detecting:StartDigging, lation_detecting:ItemFound, lation_detecting:BuyDetector, lation_detecting:BuyShovel, lation_detecting:SellOne, lation_detecting:SellAll and the bridge's lation_detecting:onPlayerLoaded). Don't trigger them from your own scripts; use the exports and hooks.

HooksCopy Anchor Link

Hooks are plain functions in the open files: edit them in place, and keep a copy of your changes before you update.

Server hooksCopy Anchor Link

In server/functions.lua.

CanUseDetectorCopy Anchor Link

function CanUseDetector(source, model)
    return true
end

Runs each time a player uses a detector, after the job, level, area and ban checks. A false stops them without a message, so send your own. GetItemCount is the bridge's.

-- Players need a permit to detect
function CanUseDetector(source, model)
    if GetItemCount(source, 'detecting_permit') < 1 then
        TriggerClientEvent('lation_detecting:Notify', source, 'You need a detecting permit', 'error')
        return false
    end
    return true
end

ItemFoundCopy Anchor Link

function ItemFound(source, model, item, quantity)
end

Runs after a find has gone into the player's inventory, before its XP is added. The script shows no message of its own for a find; the inventory's add-item notice tells the player what they got.

-- Tell everyone when someone digs up something rare
local rare = { md_presidentialwatch = true, md_platinumnugget = true }

function ItemFound(source, model, item, quantity)
    if rare[item] then
        local message = ('%s dug up something rare on the beach'):format(GetName(source))
        TriggerClientEvent('lation_detecting:Notify', -1, message, 'info')
    end
end

Client hooksCopy Anchor Link

In client/functions.lua. All four are empty.

The bridge's DisableInventory() and EnableInventory() keep players out of their inventory on ox_inventory, qb-inventory and qs-inventory. To stop the shovel from being dropped mid-dig:

function StartedDigging()
    DisableInventory()
end

function StoppedDigging()
    EnableInventory()
end

Open filesCopy Anchor Link

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

The bridges detect es_extended, qbx_core and qb-core, in that order, and ox_inventory, qb-inventory, qs-inventory, ps-inventory, origen_inventory and codem-inventory. For anything else, fill in the -- Add custom framework here and -- Add custom inventory here slots.