Developers

--- Attempts to spawn and setup the truck.
---@param locationIndex number The table index from the locations.lua file.
---@param vehData table vehicle configuration data.
---@return boolean, string|integer?
local function spawnTruck(source, locationIndex, vehData)
    return lib.callback.await("scfd_garbagejob:fetchTruck", false, source, locationIndex, vehData)
end

--- Fetches a trucks data
---@param source integer playerId
---@return privateTruckData?
local function getTruckData(source)
    return lib.callback.await("scfd_garbagejob:fetchTruckData", false, source)
end

--- Attempts to return a players truck if possible.
---@param locationIndex integer Table index of location
---@param returnPos vector3 The current position, this must match one of the positions within the location config.
TriggerServerEvent("scfd_garbagejob:returnTruck", src, locationIndex, returnPos)

--- Attempts to clock a player in, if possible.
---@param locationIndex integer Table index of location
TriggerServerEvent("scfd_garbagejob:clockIn", src, locationIndex)

--- Attempts to clock the player out, if possible.
---@param locationIndex integer Table index of location
TriggerServerEvent("scfd_garbagejob:clockOut", src, locationIndex)

---Return player's truck. If ownerOnly true, return only if player is owner (fast via map).
---@param src integer
---@param ownerOnly boolean?
---@return Truck?
local truckData = exports.scfd_garbagejob:getPlayerTruck(src, ownerOnly)

---Handle payout distribution and cleanup
---@param src integer playerId
---@param truck Truck truckData from `getPlayerTruck`
---@param crew table? crew table.
exports.scfd_garbagejob:handlePayout(src, truck, crew)

---Gives an item reward to player based on zone loot table
---@param src integer playerId
---@param zone string zoneId
exports.scfd_garbagejob:giveRandomItemReward(src, zone)

--- Gets a trucks config information from its model.
---@param model integer truckModel
---@return table?
exports.scfd_garbagejob:getTruckConfigData(model)

--- Handles the deposit refund logic when a truck is returned.
---@param src integer Player ID returning the truck
---@param truck Truck The truck being returned
exports.scfd_garbagejob:handleDeposit(src, truck)

--- Assigns a new random zone to a truck, or if there is no available zone returns nil
---@param truck Truck truckData
---@return string? newZone
local newZone = exports.scfd_garbagejob:assignZoneToTruck(truck)

--- Adds trash to the trucks current zone, if the maxCollection amount is reached it will assign a new zone.
---@param truck Truck truckData
---@param amount integer the amount of trash to add.
---@return string? newZone
local newZone = exports.scfd_garbagejob:addTrashToZone(truck, amount)

--- Attempt to clock the player in.
---@param locationIndex integer table index for location
exports.scfd_garbagejob:clockIn(locationIndex)

--- Attempt to clock the player out.
---@param locationIndex integer table index for location
exports.scfd_garbagejob:clockOut(locationIndex)

--- Opens the truck context menu to spawn a truck.
---@param locationIndex integer table index for location
exports.scfd_garbagejob:viewTrucks(locationIndex)

--- Attempts to collect payment.
---@param locationIndex integer table index for location
exports.scfd_garbagejob:collectPayment(locationIndex)

--- Attempts to return the players truck
---@param locationIndex integer table index for location
---@param inside boolean If the player is inside the truck or not.
---@param zonePos vector3 The zone position from returnPoints for the specified location index. Must match.
exports.scfd_garbagejob:returnTruck(locationIndex, inside, zonePos)

--- Attempts to unload the players truck, they must be inside
---@param locationIndex integer table index for location
---@param zonePos vector3 The zone position from unloadPoints for the specified location index. Must match.
exports.scfd_garbagejob:unloadTruck(locationIndex, zonePos)

--- Attempts to add trash to the truck.
---@param trashData {netId: integer, zone: string}
---@param truckData {netId: integer, plate: string}
exports.scfd_garbagejob:addTrashToTruck(trashData, truckData)

--- Sets the peds outfit
---@param ped integer pedID
---@param outfitId string Outfit name from data file.
exports.scfd_garbagejob:setOutfit(ped, outfitId)

--- Resets a peds outfit back to their previous one, if able.
---@param ped integer pedID
exports.scfd_garbagejob:resetOutfit(ped)

--- Opens the group management menu.
exports.scfd_garbagejob:openGroupMenu()

--- Leave the current group, if able
exports.scfd_garbagejob:leaveGroup()