Challenge class
A class representing the details of a challenge.
Signature:
export declare class Challenge Constructor
new Challenge (client: Client, data: ChallengeConfigData, percentiles: { [key in TierType]: number; })Constructs a new instance of the Challenge class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| client | Client | |
| data | ChallengeConfigData | |
| percentiles | { key in TierType: number; } |
Properties
description
The long description of the challenge (as per the client's locale).
descriptions
The long descriptions of the challenge mapped by locale.
Type: Collection < Locales, String >
id
The ID of the challenge.
Type: Number
leaderboard
Whether the challenge has a leaderboard.
Type: Boolean
name
The name of the challenge (as per the client's locale).
names
The names of the challenge mapped by locale.
Type: Collection < Locales, String >
percentiles
The percentile of player base that have reached a specific tier (mapped by tier).
Type: Collection < TierType | "NONE", Number >
shortDescription
The short description of the challenge (as per the client's locale).
shortDescriptions
The short descriptions of the challenge mapped by locale.
Type: Collection < Locales, String >
state
The state of the challenge.
Type: 'ENABLED' | 'DISABLED'
thresholds
The thresholds of the challenge mapped by tier.
Type: Collection < TierType | 'NONE', Number >