Client

This page documents all available client-side exports for SD-Horde. These exports allow you to interact with the horde system from other client-side scripts.

---

Game State

IsPlayerInHorde

Check if the local player is currently in a horde game.

local inGame, gameState = exports['sd-horde']:IsPlayerInHorde()

Returns

Name	Type	Description
inGame	boolean	Whether the player is in a horde game
gameState	string	Current game state

Game States

State	Description
none	Not in a game
starting	Game is initializing
active	Combat phase - fighting enemies
looting	Looting phase between rounds
perk_voting	Players are voting on perks
ending	Game is ending
completed	Game has been completed

Example

local inGame, state = exports['sd-horde']:IsPlayerInHorde()
if inGame then
    if state == "active" then
        print("Player is in combat!")
    elseif state == "looting" then
        print("Player is looting between rounds")
    end
end

---

GetCurrentRound

Get the current round number in the active horde game.

local round = exports['sd-horde']:GetCurrentRound()

Returns

Name	Type	Description
round	number|nil	Current round number, or nil if not in game

Example

local round = exports['sd-horde']:GetCurrentRound()
if round then
    print("Currently on round " .. round)
end

---

GetCurrentMap

Get the current map name being played.

local mapName = exports['sd-horde']:GetCurrentMap()

Returns

Name	Type	Description
mapName	string|nil	Map identifier, or nil if not in game

Example

local map = exports['sd-horde']:GetCurrentMap()
if map then
    print("Playing on map: " .. map)
end

---

HasPendingGame

Check if the local player has a pending game (heading to entry location).

local hasPending, isHost = exports['sd-horde']:HasPendingGame()

Returns

Name	Type	Description
hasPending	boolean	Whether the player has a pending game
isHost	boolean	Whether the player is the host of the pending game

Example

local pending, isHost = exports['sd-horde']:HasPendingGame()
if pending then
    if isHost then
        print("You are the host - head to the entry location!")
    else
        print("Follow your group to the entry location!")
    end
end

---

Player State

IsPlayerDead

Check if the local player is dead/downed in the current horde game. Uses comprehensive detection including medical system state bags.

local isDead, reason = exports['sd-horde']:IsPlayerDead()

Returns

Name	Type	Description
isDead	boolean	Whether the player is dead or downed
reason	string|nil	Detection source (for debugging)

Detection Reasons

Reason	Description
native_dead	GTA native IsEntityDead check
native_dying	GTA native IsPedDeadOrDying check
state_dead	Player state bag indicates dead
already_notified	Death already processed by horde system
revive_grace_period	Player was recently revived

Example

local isDead = exports['sd-horde']:IsPlayerDead()
if isDead then
    print("Player is dead, waiting for revive or round end")
end

---

IsCarryingLoot

Check if the local player is currently carrying loot.

local isCarrying, lootValue = exports['sd-horde']:IsCarryingLoot()

Returns

Name	Type	Description
isCarrying	boolean	Whether the player is carrying loot
lootValue	number	Value of carried loot (0 if not carrying)

Example

local carrying, value = exports['sd-horde']:IsCarryingLoot()
if carrying then
    print("Carrying loot worth $" .. value)
end

---

GetPlayerLevel

Get the local player's horde level, XP, and statistics.

local levelInfo = exports['sd-horde']:GetPlayerLevel()

Returns

Name	Type	Description
levelInfo	table|nil	Level information, or nil if unavailable

Level Info Object

Field	Type	Description
level	number	Current horde level
xp	number	Current XP amount
stats	table	Player statistics (kills, deaths, rounds, etc.)

Example

local info = exports['sd-horde']:GetPlayerLevel()
if info then
    print(string.format("Level %d - %d XP", info.level, info.xp))
    print("Total kills: " .. (info.stats.kills or 0))
end

---

UI Controls

OpenHordeMenu

Open the horde menu programmatically. Useful for custom NPCs or interaction systems.

local success = exports['sd-horde']:OpenHordeMenu()

Returns

Name	Type	Description
success	boolean	Whether the menu was opened (false if already in game)

Example

-- Custom NPC interaction with ox_target
exports.ox_target:addModel('your_ped_model', {
    {
        name = 'open_horde',
        icon = 'fas fa-skull',
        label = 'Horde Mode',
        onSelect = function()
            local opened = exports['sd-horde']:OpenHordeMenu()
            if not opened then
                -- Player is already in a game
            end
        end
    }
})

---

CloseAllUI

Close all open horde UI elements (shop, perk selection, end game loot, HUD).

local success = exports['sd-horde']:CloseAllUI()

Returns

Name	Type	Description
success	boolean	Always returns true

Example

-- Force close all horde UIs when player enters a cutscene
exports['sd-horde']:CloseAllUI()

---

Perks System

These exports allow you to interact with the perk system during horde games.

ApplyPerk

Apply a perk to the local player.

exports['sd-horde']:ApplyPerk(perkId)

Parameters

Name	Type	Description
perkId	string	The perk identifier to apply

---

RemovePerk

Remove a specific perk from the local player.

exports['sd-horde']:RemovePerk(perkId)

Parameters

Name	Type	Description
perkId	string	The perk identifier to remove

---

ClearAllPerks

Remove all active perks from the local player.

exports['sd-horde']:ClearAllPerks()

---

IsPerkActive

Check if a specific perk is currently active.

local isActive = exports['sd-horde']:IsPerkActive(perkId)

Parameters

Name	Type	Description
perkId	string	The perk identifier to check

Returns

Name	Type	Description
isActive	boolean	Whether the perk is active

---

GetActivePerks

Get a table of all currently active perks.

local activePerks = exports['sd-horde']:GetActivePerks()

Returns

Name	Type	Description
activePerks	table	Table of active perk IDs (key = perkId, value = true)

Example

local perks = exports['sd-horde']:GetActivePerks()
for perkId, _ in pairs(perks) do
    print("Active perk: " .. perkId)
end

---

GetActivePerksForHUD

Get active perks formatted for HUD display.

local perksForHUD = exports['sd-horde']:GetActivePerksForHUD()

Returns

Name	Type	Description
perksForHUD	table	Array of perk data formatted for UI display

---

GetPerkModifiers

Get all current perk modifiers affecting the player.

local modifiers = exports['sd-horde']:GetPerkModifiers()

Returns

Name	Type	Description
modifiers	table	Table of all active modifiers

---

Perk Modifier Exports

These exports return specific modifier values based on active perks.

Damage Modifiers

-- Get total damage multiplier from all active perks
local damageMultiplier = exports['sd-horde']:GetTotalDamageMultiplier()

-- Get damage multiplier for a specific target entity
local targetMultiplier = exports['sd-horde']:GetDamageMultiplierForTarget(targetEntity)

---

Weapon Modifiers

-- Get weapon handling modifiers (recoil, accuracy, etc.)
local handling = exports['sd-horde']:GetWeaponHandlingModifiers()

-- Check for special ammo types
local hasInfiniteAmmo = exports['sd-horde']:HasInfiniteAmmo()
local hasExplosiveRounds = exports['sd-horde']:HasExplosiveRounds()
local hasThermiteRounds = exports['sd-horde']:HasThermiteRounds()

---

Economy Modifiers

-- Get loot value multiplier
local lootMultiplier = exports['sd-horde']:GetLootValueMultiplier()

-- Get points multiplier
local pointsMultiplier = exports['sd-horde']:GetPointsMultiplier()

-- Get currency multiplier
local currencyMultiplier = exports['sd-horde']:GetCurrencyMultiplier()

-- Get bonus currency for headshots
local headshotBonus = exports['sd-horde']:GetHeadshotCurrencyBonus()

-- Get bonus currency per kill
local killBonus = exports['sd-horde']:GetKillCurrencyBonus()

---

Enemy Modifiers

These affect how enemies behave (typically from debuff perks):

local enemySpeed = exports['sd-horde']:GetEnemySpeedMultiplier()
local enemyHealth = exports['sd-horde']:GetEnemyHealthMultiplier()
local enemyDamage = exports['sd-horde']:GetEnemyDamageMultiplier()
local enemyArmor = exports['sd-horde']:GetEnemyArmorMultiplier()
local enemyAccuracy = exports['sd-horde']:GetEnemyAccuracyMultiplier()

---

Perk Event Hooks

OnEnemyKilled

Trigger perk effects when an enemy is killed.

exports['sd-horde']:OnEnemyKilled(enemyPed, wasHeadshot)

Parameters

Name	Type	Description
enemyPed	number	The enemy ped entity
wasHeadshot	boolean	Whether the kill was a headshot

---

OnPlayerDamaged

Trigger perk effects when the player takes damage.

exports['sd-horde']:OnPlayerDamaged(damageAmount)

Parameters

Name	Type	Description
damageAmount	number	Amount of damage taken

---

Mystery Box

SpawnMysteryBox

Spawn the mystery box for a specific map.

exports['sd-horde']:SpawnMysteryBox(mapName)

Parameters

Name	Type	Description
mapName	string	The map identifier

---

RemoveMysteryBox

Remove the currently spawned mystery box.

exports['sd-horde']:RemoveMysteryBox()

---

UseMysteryBox

Use the mystery box (initiate the spin animation and reward).

exports['sd-horde']:UseMysteryBox()