Exports & API Reference

This guide covers all available exports for integrating with other scripts.

---

Server-Side Exports

addHuntingXp

Add hunting XP to a player.

exports["cas-hunting"]:addHuntingXp(source, amount)

Parameter	Type	Description
source	number	Player server ID
amount	number	XP amount to add

Example:

-- Give player 50 hunting XP
exports["cas-hunting"]:addHuntingXp(source, 50)

-- Reward for completing another job
RegisterNetEvent("myScript:jobCompleted", function()
    local src = source
    exports["cas-hunting"]:addHuntingXp(src, 25)
end)

---

removeHuntingXp

Remove hunting XP from a player.

exports["cas-hunting"]:removeHuntingXp(source, amount)

Parameter	Type	Description
source	number	Player server ID
amount	number	XP amount to remove

Example:

-- Remove 30 XP as penalty
exports["cas-hunting"]:removeHuntingXp(source, 30)

-- Penalty for illegal hunting
RegisterNetEvent("police:illegalHunting", function(targetSrc)
    exports["cas-hunting"]:removeHuntingXp(targetSrc, 100)
end)

Note: XP cannot go below 0.

---

addTraceXp

Add tracking/trace XP to a player.

exports["cas-hunting"]:addTraceXp(source, amount)

Parameter	Type	Description
source	number	Player server ID
amount	number	Trace XP to add

Example:

-- Reward tracking practice
exports["cas-hunting"]:addTraceXp(source, 10)

-- Bonus XP for finding rare tracks
RegisterNetEvent("myScript:rareTrackFound", function()
    local src = source
    exports["cas-hunting"]:addTraceXp(src, 25)
end)

Level Calculation:

• Trace Level = floor(TraceXP / 100)

• Max Level: 5 (configurable)

---

Client-Side Exports

PlaceBait

Place bait at the player's current location.

exports["cas-hunting"]:PlaceBait(baitItemName)

Parameter	Type	Description
baitItemName	string	The inventory item name

Example:

-- Place corn bait
exports["cas-hunting"]:PlaceBait("bait_corn")

-- Custom bait placement from another script
RegisterCommand("placebait", function()
    exports["cas-hunting"]:PlaceBait("bait_meat")
end)

Requirements:

• Player must be in an active hunting area

• Player must have the bait item in inventory

Available Bait Items:

Item Name	Description
bait_corn	Herbivore bait
bait_apples	Herbivore bait
bait_salt	Premium herbivore bait
bait_meat	Predator bait
bait_blood	Premium predator bait
bait_legendary	Legendary bait
bait_grain	Bird bait
bait_seeds	Bird bait
bait_exotic	Universal premium bait

---

Integration Examples

Quest System Integration

-- Server-side: Reward hunting XP for quest completion
RegisterNetEvent("questSystem:complete", function(questId)
    local src = source
    local huntingQuests = {
        ["hunt_deer"] = 50,
        ["hunt_bear"] = 100,
        ["track_animals"] = 25,
    }

    if huntingQuests[questId] then
        exports["cas-hunting"]:addHuntingXp(src, huntingQuests[questId])
    end
end)

Job System Integration

-- Server-side: Bonus XP for hunting job workers
RegisterNetEvent("job:clockIn", function(jobName)
    local src = source
    if jobName == "hunter" then
        -- Store that this player is on hunting job
        SetPlayerHunterJob(src, true)
    end
end)

RegisterNetEvent("job:clockOut", function(jobName)
    local src = source
    if jobName == "hunter" then
        -- Give bonus XP for work session
        exports["cas-hunting"]:addHuntingXp(src, 20)
    end
end)

Reputation System Integration

-- Server-side: Hunting XP affects reputation
RegisterNetEvent("cas:server:onHuntingAnimalKilled", function()
    local src = source
    -- Your reputation system
    exports["myReputation"]:addReputation(src, "wildlife", 5)
end)

Skill Check Integration

-- Client-side: Use trace level for skill checks
local function GetPlayerTrackingSkill()
    local traceLevel = LocalPlayer.state.TraceLevel or 0
    return traceLevel
end

-- Example: Better loot based on tracking skill
RegisterNetEvent("loot:searchAnimal", function(animalEntity)
    local skill = GetPlayerTrackingSkill()
    local bonusChance = skill * 0.1 -- 10% per level

    if math.random() < bonusChance then
        -- Give bonus loot
    end
end)

Economy Integration

-- Server-side: Track hunting earnings
RegisterNetEvent("cas:server:deliverHuntingLoot", function(deliveredList)
    local src = source
    -- Your logging system
    exports["myEconomy"]:logTransaction(src, "hunting_delivery", #deliveredList)
end)

---

State Bags

The hunting system uses state bags for cross-script communication:

Client State

-- Get player's trace level
local traceLevel = LocalPlayer.state.TraceLevel or 0

Server State

-- Set trace level (internal use)
local state = Player(src).state
state:set("TraceLevel", level, true)

---

Global Variables (Client)

These variables are available in client-side scripts:

-- Check if hunting is active
if isHuntingStarted then
    -- Player has an active hunting contract
end

-- Access spawned animals
for ped, data in pairs(SpawnedAnimals) do
    -- ped = entity handle
    -- data.center = spawn center
    -- data.radius = spawn radius
    -- data.isPredator = boolean
end

-- Current mission data
if CurrentMission then
    local coords = CurrentMission.radiusCoords
    local radius = CurrentMission.radius
    local animals = CurrentMission.animals
end

---

Best Practices

Error Handling

-- Always check if export exists
local function SafeAddHuntingXP(src, amount)
    local success, err = pcall(function()
        exports["cas-hunting"]:addHuntingXp(src, amount)
    end)

    if not success then
        print("[Warning] cas-hunting not available: " .. tostring(err))
    end
end

Performance

-- Cache export reference for frequent calls
local addXP = exports["cas-hunting"].addHuntingXp

-- Use cached reference
addXP(source, 10)

Validation

-- Validate inputs before calling exports
local function RewardHuntingXP(src, amount)
    if not src or type(src) ~= "number" then return end
    if not amount or amount <= 0 then return end

    exports["cas-hunting"]:addHuntingXp(src, amount)
end

---