Class Achievements

Index

Constructors

Methods

count define drainNew increment progress subProgress toJSON unlocked fromJSON

Constructors

constructor

new Achievements(): Achievements

Returns Achievements

Methods

count

count(counter: string): number
the current value of a counter; 0 for one nothing has touched yet
Parameters
- counter: string
Returns number
- Defined in src/core/Achievements.ts:86

define

define(definition: AchievementDef): void
Parameters
- definition: AchievementDef
Returns void
- Defined in src/core/Achievements.ts:81

drainNew

drainNew(): string[]
every id unlocked but not yet announced, clearing the queue as it reads

Returns string[]
- Defined in src/core/Achievements.ts:150

increment

increment(counter: string, amount?: number): string[]
Adds to a counter, unlocking whatever that newly earns - a multi-criteria achievement unlocks only on the increment that leaves every one of its criteria met.
Parameters
- counter: string
- amount: number = 1
Returns string[]
the ids unlocked by exactly this increment, so a game can announce each one once ("Achievement unlocked: ...") rather than re-scanning everything
- Defined in src/core/Achievements.ts:97

progress

progress(id: string): { count: number; target: number }
Progress towards a single-criterion achievement: current count and target - throws for an unknown id or a multi-criteria one (use subProgress there instead).
Parameters
- id: string
Returns { count: number; target: number }
- Defined in src/core/Achievements.ts:131

subProgress

subProgress(
id: string,
): readonly { count: number; counter: string; met: boolean; target: number }[]
progress towards each of an achievement's criteria, in definition order - throws for an unknown id
Parameters
- id: string
Returns readonly { count: number; counter: string; met: boolean; target: number }[]
- Defined in src/core/Achievements.ts:140

toJSON

toJSON(): { counts: [string, number][] }
Returns { counts: [string, number][] }
- Defined in src/core/Achievements.ts:156

unlocked

unlocked(id: string): boolean
whether every one of an achievement's criteria has reached its target - throws for an unknown id
Parameters
- id: string
Returns boolean
- Defined in src/core/Achievements.ts:121

`Static`fromJSON

fromJSON(
definitions: AchievementDef[],
data: { counts: [string, number][] },
): Achievements
rebuilds achievements from save data - definitions are supplied fresh, the same as QuestLog
Parameters
- definitions: AchievementDef[]
- data: { counts: [string, number][] }
Returns Achievements
- Defined in src/core/Achievements.ts:161