Skip to main content

Class: RankedClan

Represents the Clan of location based leader-board ranking.

Constructors

constructor

new RankedClan(data)

Parameters

NameType
dataAPIClanRanking | APIClanBuilderBaseRanking

Defined in

struct/Ranking.ts:146

Properties

name

name: string

The clan's name.

Defined in

struct/Ranking.ts:117


tag

tag: string

The clan's tag.

Defined in

struct/Ranking.ts:120


level

level: number

The clan's level.

Defined in

struct/Ranking.ts:123


points

points: null | number

The clan's trophy count. If retrieving info for builder base leader-boards, this will be null.

Defined in

struct/Ranking.ts:126


builderBasePoints

builderBasePoints: null | number

The clan's builder base trophy count. If retrieving info for regular leader boards, this will be null.

Defined in

struct/Ranking.ts:129


location

location: Location

The clan's location.

Defined in

struct/Ranking.ts:132


memberCount

memberCount: number

The number of members in the clan.

Defined in

struct/Ranking.ts:135


rank

rank: number

The clan's rank in the leader board.

Defined in

struct/Ranking.ts:138


previousRank

previousRank: number

The clan's rank in the previous season's leader-board.

Defined in

struct/Ranking.ts:141


badge

badge: Badge

The clan's badge.

Defined in

struct/Ranking.ts:144

Accessors

get shareLink(): string

Get clan's formatted link to open clan in-game.

Returns

string

Defined in

struct/Ranking.ts:162