Skip to main content

AchievementContextType

Defined in: src/providers/AchievementProvider.tsx:18

Properties

_isLegacyPattern

_isLegacyPattern: boolean

Defined in: src/providers/AchievementProvider.tsx:39

Deprecated

Use provider props or the presence of an injected engine directly. This compatibility flag will be removed in 5.0.


achievements

achievements: object

Defined in: src/providers/AchievementProvider.tsx:20

all

all: Record<string, AchievementWithStatus>

unlocked

unlocked: string[]


engine

engine: AchievementEngine

Defined in: src/providers/AchievementProvider.tsx:33


exportData()

exportData: () => string

Defined in: src/providers/AchievementProvider.tsx:30

Returns

string


getAllAchievements()

getAllAchievements: () => AchievementWithStatus[]

Defined in: src/providers/AchievementProvider.tsx:32

Returns

AchievementWithStatus[]


getState()

getState: () => object

Defined in: src/providers/AchievementProvider.tsx:26

Returns

object

metrics

metrics: Record<string, any>

unlocked

unlocked: string[]


icons

icons: Record<string, string>

Defined in: src/providers/AchievementProvider.tsx:34


importData()

importData: (jsonString, options?) => ImportResult

Defined in: src/providers/AchievementProvider.tsx:31

Parameters

jsonString

string

options?

ImportOptions

Returns

ImportResult


reset()

reset: () => void

Defined in: src/providers/AchievementProvider.tsx:25

Returns

void


snapshot

snapshot: AchievementSnapshot

Defined in: src/providers/AchievementProvider.tsx:24


update()

update: (metrics) => void

Defined in: src/providers/AchievementProvider.tsx:19

Parameters

metrics

Record<string, any>

Returns

void