> For the complete documentation index, see [llms.txt](https://vanishdev.gitbook.io/vanishdev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vanishdev.gitbook.io/vanishdev/gang-series/turfs/exports.md).

# Exports

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

**Client**

No client-side exports available.

***

**Server**

The turf system provides simple function exports for interacting with turf wars and gang statistics.

#### Available Exports

**GetLeaderboardData**

```lua
local leaderboard = exports.vanish_turfs:GetLeaderboardData()
```

Returns: Array of gang statistics ordered by wins (descending)

```lua
{
    {
        id = 1,                    -- Gang database ID
        name = "Ballas",          -- Gang name (or label if GetGangLabel is available)
        totalWins = 15,           -- Total turf wars won
        totalBattles = 20,        -- Total turf wars participated in
        logoUrl = "https://..."   -- Gang logo URL (empty string if not set)
    },
    -- ... more gangs
}
```

**GetActiveTurfs**

```lua
local activeTurfs = exports.vanish_turfs:GetActiveTurfs()
```

Returns: Array of currently active turf wars

```lua
{
    {
        label = "Grove Street",   -- Zone label
        remaining = 120           -- Remaining seconds until completion
    },
    -- ... more active turfs
}
```

**ForceEndTurf**

```lua
local success = exports.vanish_turfs:ForceEndTurf(zoneLabel)
```

**Parameters:**

* `zoneLabel` (string) - The zone label to force end

Returns: boolean - Whether the turf was successfully ended

**Note:** This will trigger reward distribution, stats recording, and respawn logic just like a normal turf completion.

**GetGangStats**

```lua
local gangStats = exports.vanish_turfs:GetGangStats(gangName)
```

**Parameters:**

* `gangName` (string) - The gang name to look up

Returns: Gang statistics object or nil if gang not found

```lua
{
    id = 1,                    -- Gang database ID
    name = "Ballas",          -- Gang name (or label if GetGangLabel is available)
    totalWins = 15,           -- Total turf wars won
    totalBattles = 20,        -- Total turf wars participated in
    logoUrl = "https://..."   -- Gang logo URL (empty string if not set)
}
```

**GetZones**

```lua
local zones = exports.vanish_turfs:GetZones()
```

Returns: the current turf zones, including any built or changed with the in-game editor. Handy for drawing turf areas on an external map or web panel.

***

#### Usage Examples

**Check Active Turfs**

```lua
local activeTurfs = exports.vanish_turfs:GetActiveTurfs()

if #activeTurfs > 0 then
    print(('There are %d active turfs'):format(#activeTurfs))
    for _, turf in ipairs(activeTurfs) do
        print(('- %s: %ds remaining'):format(turf.label, turf.remaining))
    end
else
    print('No active turfs')
end
```

**Get Gang Statistics**

```lua
local gangStats = exports.vanish_turfs:GetGangStats('ballas')

if gangStats then
    local winRate = gangStats.totalBattles > 0 
        and (gangStats.totalWins / gangStats.totalBattles * 100) 
        or 0
    
    print(('%s: %d wins / %d battles (%.1f%% win rate)'):format(
        gangStats.name, 
        gangStats.totalWins, 
        gangStats.totalBattles, 
        winRate
    ))
else
    print('Gang not found in statistics')
end
```

**Display Leaderboard**

```lua
local leaderboard = exports.vanish_turfs:GetLeaderboardData()

print('=== Turf War Leaderboard ===')
for i, gang in ipairs(leaderboard) do
    print(('%d. %s - %d wins (%d battles)'):format(
        i, 
        gang.name, 
        gang.totalWins, 
        gang.totalBattles
    ))
end
```

***

#### Commands

| Command            | Description                                                  |
| ------------------ | ------------------------------------------------------------ |
| `/turfleaderboard` | Open the leaderboard. Name set by `leaderboard.commandName`. |
| `/turfsettings`    | Open the per-player settings menu.                           |
| `/turfeditor`      | Open the in-game zone editor.                                |
| `/turfs`           | Open the admin turf panel.                                   |
| `/turfstart`       | Force start a turf.                                          |
| `/turfsend`        | Force end a turf.                                            |
| `/turfextend`      | Extend a running turf.                                       |
| `/setturfganglogo` | Set a gang's logo.                                           |

Every command's access is controlled by the `commands` block in `shared/config.lua`. By default the leaderboard and settings are open to everyone and the rest are admin only.