> For the complete documentation index, see [llms.txt](https://titans-productions.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://titans-productions.gitbook.io/documentation/redm/scripts/clans/development-api/server.md).

# Server

Before reading client and server exports and events, you can also edit specific code through escrow\_ignore.lua files that we provide in client and server directory folders.

### Exports

API Getter Function

```lua
local ClansAPI = exports.tp_clans:getAPI()
```

1. Get all clans

```lua
--- @return table.
local Clans = ClansAPI.GetClans()
```

3. Get clan data by clan id.

```lua
-- @param clanId : requires an integer.
local ClanData = ClansAPI.GetClanData(clanId)

--- @param ClanData.coords return table
--- @param ClanData.furnitures return table
--- @param ClanData.raids_history return table
--- @param ClanData.members return table
--- @param ClanData.notifications return table
--- @param ClanData.alliances return table
--- @param ClanData.identifier return string
--- @param ClanData.charidentifier return integer
--- @param ClanData.name return string
--- @param ClanData.id return integer
--- @param ClanData.ledger return integer
--- @param ClanData.upgrade return integer
--- @param ClanData.level return integer
--- @param ClanData.level_experience return integer

```

3. Get player clan id (By Source)

```lua
-- @param source : requires an integer (player online id)
local ClanId = ClansAPI.GetPlayerClanId(source)

--- @param ClanId return 0 if there is no clan
```

4. Get player clan id (By Identifiers)

```lua
-- @param identifier : requires a string (the player steam hex)
-- @param charIdentifier : requires an integer (the player character id)
local ClanId = ClansAPI.GetPlayerClanIdOffline(identifier, charIdentifier)

--- @param ClanId return 0 if there is no clan
```

5. Kick a player from a clan (Online - By Source)

```lua
-- @param clanId : requires an integer.
-- @param source : requires an integer (player online id)
ClansAPI.KickPlayerClanMember(clanId, source)
```

6. Kick a player from a clan (Offline - By Identifiers)

```lua
-- @param clanId : requires an integer.
-- @param identifier : requires a string (the player steam hex)
-- @param charIdentifier : requires an integer (the player character id)
ClansAPI.KickPlayerClanMemberOffline(clanId, identifier, charIdentifier)
```

7. Add a new clan member(s).

```lua
-- @param clanId : requires an integer.
-- @param source : requires an integer (player online id)
ClansAPI.AddPlayerClanMember(clanId, source)
```

8. Disband a clan by its id.

```lua
-- @param clanId : requires an integer.
ClansAPI.DisbandClanById(clanId)
```

9. Delete a clan by its id.

```lua
-- @param clanId : requires an integer.
ClansAPI.DeleteClanById(clanId)
```

10. Add clan level

```lua
-- @param clanId : requires an integer.
-- @param level : requires an integer
ClansAPI.AddLevel(clanId, level)
```

11. Add clan level experience

```lua
-- @param clanId : requires an integer.
-- @param experienece : requires an integer (max is 10000 to get a level)
ClansAPI.AddLevelExperience(clanId, experienece)
```

12. Add clan points

```lua
-- @param clanId : requires an integer.
-- @param points : requires an integer
ClansAPI.AddPoints(clanId, points)
```

13. Remove clan points

```lua
-- @param clanId : requires an integer.
-- @param points : requires an integer
ClansAPI.RemovePoints(clanId, points)
```

14. Check if a clan mission is active.

```lua
local clanId = ClansAPI.GetPlayerClanId(source) -- example

-- @param clanId : requires an integer.
-- @param missionName : requires a string (a mission name, either a custom one or existing one, ex: 'CRAYFISH')
local hasActiveMission, missionData = ClansAPI.HasClanMissionActiveByName(clanId, missionName)
```

15. Decrease the required value if a clan mission is active **(THIS IS ONLY FOR DAILY MISSIONS)**

```lua
local clanId = ClansAPI.GetPlayerClanId(source) -- example

if clanId ~= 0 then -- if clanId equals to 0, it means the player does not belong to any clan.
    -- @param clanId : requires an integer.
    -- @param missionName : requires a string (a mission name, either a custom one or existing one, ex: 'CRAYFISH')
    local hasActiveMission, missionData = ClansAPI.HasClanMissionActiveByName(clanId, missionName)

    -- @param decreaseAmount : requires an integer (decreaseAmount is the input value that you want to decrease from a daily mission, for example, if a player must catch (5) crayfishes, you can set the value to `1` so 4 crayfish catches will remain to do).
    if hasActiveMission then 
        ClansAPI.DecreaseClanMissionRequiredValueByName(clanId, missionName, decreaseAmount)
    end
end

```

16. Set an active clan as finished (this is only for weekly missions, the daily missions will be done automatically once reached to 0 actions left).

```lua
-- MUST DO ALL CHECKS AS `13` EXPORT EXAMPLE.

-- @param clanId : requires an integer.
-- @param missionName : requires a string (a mission name, either a custom one or existing one, ex: 'RAID_MISSION')
ClansAPI.SetClanMissionFinishedByName(clanId, missionName)
```

### Events

1. Send an advanced notification to the desired clan.

```lua

-- @param message : requires a string (the notification message)
-- @param notificationType : requires a string (success, info, warning)
-- @param isImportant : requires an integer value (0 = not important, 1 = important )
local data = {
    message = message, 
    type = notificationType, 
    important = isImportant,
}

TriggerEvent('tp_clans:server:notifications:send', clanId, data) -- server > server
```

2. This event is triggered once a raiding has officially started.

```lua
-- @param source : requires an integer (player online id - the one who started the raid)
-- @param clanId : requires an integer (source main clan id)
-- @param targetClanId : requires an integer (enemy clan id)

RegisterServerEvent('tp_clans:server:raids:started_raiding')
AddEventHandler('tp_clans:server:raids:started_raiding', function(source, clanId, targetClanId)
    -- todo
end)
```