Exports

List of exports required for developers to integrate this script into their own resources.

Client

No client-side exports available.

---

Server

The gang system provides two types of exports: Helper Exports (recommended for most use cases) and Direct Module Exports (for advanced usage requiring full module access).

Helper Exports (Recommended)

Simple function wrappers for common operations:

GetPlayerGang

local playerGang = exports.vanish_gangs:GetPlayerGang(playerId)

Returns: Table with gang information or nil

{
    name = "gangName",        -- Gang identifier
    rank = 3,                 -- Numeric rank
    rankString = "Soldier",   -- Rank display label
    isLeader = false          -- Leadership status
}

GetGangMembers

local members = exports.vanish_gangs:GetGangMembers(gangName)

Returns: Array of member objects

{
    {
        identifier = "char1:abc123",
        gangRank = 3,
        title = "John Doe",
        description = "Gang rank: 3",
        icon = "fa-solid fa-user"
    }
}

DoesGangExist

local exists = exports.vanish_gangs:DoesGangExist(gangName)

Returns: boolean - Whether the gang exists

GetGangLabel

local label = exports.vanish_gangs:GetGangLabel(gangName)

Returns: string - Gang display label or nil

IsPlayerInGang

local inGang = exports.vanish_gangs:IsPlayerInGang(playerId)

Returns: boolean - Whether the player is in any gang

---

Direct Module Exports (Advanced Usage)

For advanced usage requiring full module access and methods.

Cache Module (Gangs)

local gangs = exports.vanish_gangs:Gangs()

Direct Data Access:

• gangs.gangs - Table of all gangs indexed by gang name

• gangs.ranks - Table of all ranks indexed by gangName_rankNumber

Available Methods:

gangs.GetGangLabel(gangName)                  -- Get gang display label
gangs.DoesGangExist(gangName)                 -- Check if gang exists
gangs.DoesGangHaveRanks(gangName)             -- Check if gang has all ranks configured
gangs.DoesRankExist(key)                      -- Check if rank key exists (format: "gangName_rankNumber")
gangs.DoesRankNameExist(gangName, rankName)   -- Check if rank name exists for gang
gangs.DoesRankLabelExist(gangName, rankLabel) -- Check if rank label exists for gang
gangs.IsRankWithinInterval(gangName, rank)    -- Validate rank number is within gang's range
gangs.IsLeadershipRank(gangName, rank)        -- Check if rank is the leadership rank
gangs.GetPlayerGang(playerId)                 -- Get player's gang data
gangs.GetMembers(gangName)                    -- Get all members of a gang

Admin Module (GangAdmin)

local admin = exports.vanish_gangs:GangAdmin()

Available Methods:

admin.CreateGang(data)                        -- data = {name, label, leadershipRank, passcode}
admin.CreateRank(data)                        -- data = {gangName, name, label, ranking}
admin.DeleteGang(gangName)                    -- Delete gang and all associated data
admin.DeleteRank(gangName, rankNumber)        -- Delete specific rank
admin.UpdateRankLabel(gangName, rankNumber, rankLabel, rankName) -- Update rank display info
admin.UpdateRankRanking(gangName, rankNumber, rankRanking)       -- Change rank number
admin.SetPasscode(gangName, passcode)         -- Update gang inventory passcode

Members Module (GangMembers)

local members = exports.vanish_gangs:GangMembers()

Available Methods:

members.SendInvite(gangName, playerId)        -- Send gang invite to player
members.AcceptInvite(gangName, playerId)      -- Accept pending invite
members.DeclineInvite(playerId)               -- Decline pending invite
members.InsertPlayer(gangName, gangRank, playerId)           -- Add player to gang
members.RemovePlayer(gangName, playerId, isKicked)           -- Remove player from gang
members.PromotePlayer(identifier, gangName, toRank)          -- Promote player
members.DemotePlayer(identifier, gangName, toRank)           -- Demote player

---

Usage Examples

Simple Usage:

-- Check if player is in a gang
if exports.vanish_gangs:IsPlayerInGang(source) then
    local gangData = exports.vanish_gangs:GetPlayerGang(source)
    print(gangData.name, gangData.rankString)
end

-- Get gang members
local memberList = exports.vanish_gangs:GetGangMembers('ballas')

Advanced Usage:

-- Access the full Cache module
local gangs = exports.vanish_gangs:Gangs()

-- Direct access to cached gang data
for gangName, gangData in pairs(gangs.gangs) do
    print(gangName, gangData.label, gangData.leadership_rank)
end

-- Use module methods with dot notation
if gangs.IsLeadershipRank('ballas', 5) then
    print('Player is a leader')
end

local playerGang = gangs.GetPlayerGang(source)
if playerGang then
    print(playerGang.name, playerGang.rank)
end

-- Administrative operations
local admin = exports.vanish_gangs:GangAdmin()
admin.CreateGang({'newgang', 'New Gang', 5, '1234'})
admin.SetPasscode('ballas', '5678')

-- Member management
local members = exports.vanish_gangs:GangMembers()
members.InsertPlayer('ballas', 1, playerId)
members.PromotePlayer(identifier, 'ballas', 3)