🛡️Clans

No Setup Required: Clans work automatically on any leaderboard. Just make sure you've enabled the Teams tab in your leaderboard settings on the dashboard. These methods are provided as extras for your convenience.

How clans work

Clans are groups of players whose score is added together and compared against other clans. Clans have a group chat enabled by default and are great for adding a group competitive dynamic.

✨ Show clan home

Users can manage their team and chat with other members from here. Users can get to this page from the leaderboard, but this is an optional shortcut for you to open their clan view directly.

Unity

//Show this user's clan home page
GalaxyClientAPI.Controller.OpenClan(LeaderboardId: "leaderboard_id"); 

//Show another clan home page
GalaxyClientAPI.Controller.OpenClan(
    LeaderboardId: "leaderboard_id", 
    ClanId: "clan_id", 
    Options: ViewOptions
); 

Javascript / Cordova

window.galaxy.ShowClan({
  leaderboard_id: 'leaderboard_id',
  clan_id: '' //leave blank to show this user's clan
});

iOS

GalaxySDK.shared.showClan(clanId: "", leaderboardId: "leaderboard id")

GameMaker

Galaxy_ShowClan(leaderboard_id, clan_id?) //clan_id is optional

⬇️ Get current clan

Returns the clan a player is currently a part of, or nothing if the player is not in a clan already.

Unity

GalaxyClientAPI.GetCurrentClan(new GalaxySDK.ClientModels.GetCurrentClanRequest { 
}, result => { 
    Debug.Log(result.Clan.Name)
}, error => { })

Javascript / Cordova

window.galaxy.ClientAPI.GetCurrentClan({}, (result) => {
    console.log(result.clan.name)
}, (error) => { })

iOS

GalaxySDK.shared.getCurrentClan { clan in
    let clanId = clan.clanId
}

GameMaker

Galaxy_GetCurrentClan(function(response) {
    show_message_async(response.clan.name)
})  

Clan Objects

Response

/// Details for the clan.
public Clan Clan;

Clan reference