Skip to main content

AchievementContextType

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

Properties​

_isLegacyPattern​

_isLegacyPattern: boolean

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

Deprecated​

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

achievements​

achievements: object

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

all​

all: Record<string, AchievementWithStatus>

unlocked​

unlocked: string[]

client?​

optional client: AchievementClient

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

engine?​

optional engine: AchievementEngine

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

error​

error: Error | null

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

event()​

event: (name, payload?) => void | Promise<void | AchievementClientMutationResult>

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

Parameters​

name​

string

payload?​

unknown

Returns​

void | Promise<void | AchievementClientMutationResult>

exportData()​

exportData: () => string

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

Returns​

string

getAllAchievements()​

getAllAchievements: () => AchievementWithStatus[]

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

Returns​

AchievementWithStatus[]

getState()​

getState: () => object

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

Returns​

object

metrics​

metrics: Record<string, any>

unlocked​

unlocked: string[]

icons​

icons: Record<string, string>

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

importData()​

importData: (jsonString, options?) => ImportResult

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

Parameters​

jsonString​

string

options?​

ImportOptions

Returns​

ImportResult

increment()​

increment: (metric, amount?) => void | AchievementUpdateResult | Promise<void | AchievementClientMutationResult>

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

Parameters​

metric​

string

amount?​

number

Returns​

void | AchievementUpdateResult | Promise<void | AchievementClientMutationResult>

isLoading​

isLoading: boolean

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

recentlyUnlocked​

recentlyUnlocked: AchievementWithStatus[]

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

refresh()​

refresh: () => Promise<AchievementSnapshot>

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

Returns​

Promise<AchievementSnapshot>

reset()​

reset: () => void | Promise<void>

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

Returns​

void | Promise<void>

snapshot​

snapshot: AchievementSnapshot

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

update()​

update: (metrics) => void | AchievementUpdateResult | Promise<void | AchievementClientMutationResult>

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

Parameters​

metrics​

Record<string, any>

Returns​

void | AchievementUpdateResult | Promise<void | AchievementClientMutationResult>