Class Achievements

Index

Methods

create register unregister has isUnlocked getProgress add set reset resetAll list toSnapshot fromSnapshot dispose

Methods

`Static`create

create(opts?: AchievementsOptions): Achievements
Parameters
- opts: AchievementsOptions = {}
Returns Achievements
- Defined in runtime/achievements.ts:77

register

register(spec: AchievementSpec): boolean
Parameters
- spec: AchievementSpec
Returns boolean
- Defined in runtime/achievements.ts:82

unregister

unregister(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/achievements.ts:101

has

has(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/achievements.ts:106

isUnlocked

isUnlocked(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/achievements.ts:110

getProgress

getProgress(id: string): number
Parameters
- id: string
Returns number
- Defined in runtime/achievements.ts:115

add

add(id: string, delta: number): boolean
Parameters
- id: string
- delta: number
Returns boolean
- Defined in runtime/achievements.ts:123

set

set(id: string, value: number): boolean
Parameters
- id: string
- value: number
Returns boolean
- Defined in runtime/achievements.ts:133

reset

reset(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/achievements.ts:144

resetAll

resetAll(): number
Returns number
- Defined in runtime/achievements.ts:155

list

list(): ActiveAchievement[]
Returns ActiveAchievement[]
- Defined in runtime/achievements.ts:168

toSnapshot

toSnapshot(): Record<string, AchievementSnapshotEntry>
Returns Record<string, AchievementSnapshotEntry>
- Defined in runtime/achievements.ts:182

fromSnapshot

fromSnapshot(snap: Record<string, AchievementSnapshotEntry>): void
Parameters
- snap: Record<string, AchievementSnapshotEntry>
Returns void
- Defined in runtime/achievements.ts:198

dispose

dispose(): void
Returns void
- Defined in runtime/achievements.ts:217