Developers

Every export is called on exports.lation_diving. 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_diving:openMenu()

Opens the clerk's Scuba Diving menu wherever the player is, after asking CanOpenMenu. It doesn't check setup.job or the clerk's hours, so check what you need before calling it. The shops, the boat deposit and the refund still only go through within 15 meters of start.coords, unless you set it to false.

-- With start.coords = false: open the menu from your own ped or zone
exports.lation_diving:openMenu()

isGearEquippedCopy Anchor Link

local wearing = exports.lation_diving:isGearEquipped()

if exports.lation_diving:isGearEquipped() then
    return lib.notify({ description = 'Take your scuba gear off first', type = 'error' })
end

getPlayerData (client)Copy Anchor Link

local data = exports.lation_diving:getPlayerData(type)

Asks the server, so it waits for the answer. The first time a player is looked up, their record is made at level 1.

local level = exports.lation_diving:getPlayerData('level')

getLevelDataCopy Anchor Link

local levels = exports.lation_diving:getLevelData()

The same export exists on the client and the server.

{ [1] = 0, [2] = 2500, [3] = 10000, [4] = 20000, [5] = 50000 }

Server exportsCopy Anchor Link

getPlayerDataCopy Anchor Link

local data = exports.lation_diving:getPlayerData(source, type)

The first time a player is looked up, a record is made at level 1 and saved. The record is the cached one, so treat it as read-only and change it with addPlayerData.

{
    identifier = 'ABC12345',
    name = 'Jane Doe',  -- character name when the record was made
    level = 2,
    exp = 3120,         -- total XP
    crates = 914,       -- crates picked up
    depth = 239,        -- deepest dive, in feet unless setup.metric is on
    swam = 21245,       -- distance swum underwater in scuba gear, same unit
}

local level = exports.lation_diving:getPlayerData(source, 'level')
if level and level >= 3 then
    -- let them buy from your own dive gear shop
end

addPlayerDataCopy Anchor Link

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

Nothing is written straight away: the record is saved when the player leaves, when the resource stops and when txAdmin shuts the server down.

-- 250 diving XP for finishing your own beach clean-up job
exports.lation_diving:addPlayerData(source, 'exp', 250)

Functions to editCopy Anchor Link

These ship empty or simple in the open files, for your own code.

CanOpenMenuCopy Anchor Link

function CanOpenMenu()
    return true
end

Asked every time the menu opens, from the clerk or from openMenu.

-- Only on foot
function CanOpenMenu()
    return not cache.vehicle
end

CrateCollectedCopy Anchor Link

function CrateCollected(source, quantity)
end

Called each time a player picks up a crate, after the crate is in their inventory and before their XP is added.

DivingStoppedCopy Anchor Link

function DivingStopped(source)
end

Called when a group's dive ends: the leader picks Stop Diving or Stop in Continue Diving?, or, with start.continue off, the leader picks up the last crate.

Open filesCopy Anchor Link

These ship open, outside the escrow, so you can edit them:

When you add a custom input dialog, note that ShowInput in client/functions.lua tests shared.setup.dialogss for its custom branch; correct it to dialogs so yours runs.

The hotspot messages go through SendEmail(source, message) in server/functions.lua. To use another phone, add a branch for it:

elseif Phone == 'my-phone' then
    exports['my-phone']:sendMail(source, 'Diving Expert', 'Scuba Diving', message) 

Add your phone to InitializePhone at the top of the same file too, so it's found on start.