AchievementEngine
Defined in: node_modules/achievements-engine/dist/index.d.ts:266
AchievementEngine - Framework-agnostic achievement system Event-based core with support for multiple storage backends
Extends
EventEmitter
Constructors
Constructor
new AchievementEngine(
config):AchievementEngine
Defined in: node_modules/achievements-engine/dist/index.d.ts:274
Parameters
config
Returns
AchievementEngine
Overrides
EventEmitter.constructor
Methods
destroy()
destroy():
void
Defined in: node_modules/achievements-engine/dist/index.d.ts:352
Clean up resources and event listeners
Returns
void
emit()
emit<
T>(eventName,data?):void
Defined in: node_modules/achievements-engine/dist/index.d.ts:304
Emit a custom event and optionally update metrics based on event mapping
Type Parameters
T
T = any
Parameters
eventName
string
Name of the event
data?
T
Event data
Returns
void
Overrides
EventEmitter.emit
eventNames()
eventNames():
string[]
Defined in: node_modules/achievements-engine/dist/index.d.ts:52
Get all event names that have listeners
Returns
string[]
Array of event names
Inherited from
EventEmitter.eventNames
export()
export():
string
Defined in: node_modules/achievements-engine/dist/index.d.ts:356
Export achievement data as JSON string
Returns
string
getAllAchievements()
getAllAchievements():
AchievementWithStatus[]
Defined in: node_modules/achievements-engine/dist/index.d.ts:339
Get all achievements with their unlock status
Returns
AchievementWithStatus[]
getMetrics()
getMetrics<
T>():Readonly<Partial<T>>
Defined in: node_modules/achievements-engine/dist/index.d.ts:331
Get current metrics (readonly to prevent external modification)
Type Parameters
T
T extends Record<string, any>
Returns
Readonly<Partial<T>>
getSnapshot()
getSnapshot():
AchievementSnapshot
Defined in: node_modules/achievements-engine/dist/index.d.ts:343
Get one React-friendly snapshot of all derived achievement state.
Returns
getUnlocked()
getUnlocked(): readonly
string[]
Defined in: node_modules/achievements-engine/dist/index.d.ts:335
Get unlocked achievement IDs (readonly)
Returns
readonly string[]
import()
import(
jsonString,options?):ImportResult
Defined in: node_modules/achievements-engine/dist/index.d.ts:362
Import achievement data from JSON string
Parameters
jsonString
string
Exported achievement data
options?
Import options
Returns
increment()
increment(
metric,amount?):AchievementUpdateResult
Defined in: node_modules/achievements-engine/dist/index.d.ts:314
Increment a numeric metric by the provided amount. Non-numeric and missing metric values are treated as 0.
Parameters
metric
string
amount?
number
Returns
listenerCount()
listenerCount(
event):number
Defined in: node_modules/achievements-engine/dist/index.d.ts:47
Get the number of listeners for an event
Parameters
event
string
Event name
Returns
number
Number of listeners
Inherited from
EventEmitter.listenerCount
off()
off(
event,handler):void
Defined in: node_modules/achievements-engine/dist/index.d.ts:380
Unsubscribe from an event
Parameters
event
Event name
handler
(data) => void
Event handler
Returns
void
Overrides
EventEmitter.off
on()
on(
event,handler):UnsubscribeFn
Defined in: node_modules/achievements-engine/dist/index.d.ts:368
Subscribe to engine events
Parameters
event
Event name
handler
(data) => void
Event handler
Returns
Overrides
EventEmitter.on
once()
once(
event,handler):UnsubscribeFn
Defined in: node_modules/achievements-engine/dist/index.d.ts:374
Subscribe to an event once
Parameters
event
Event name
handler
(data) => void
Event handler
Returns
Overrides
EventEmitter.once
ready()
ready():
Promise<AchievementSnapshot>
Defined in: node_modules/achievements-engine/dist/index.d.ts:327
Wait until the engine has loaded any async storage state.
Returns
Promise<AchievementSnapshot>
removeAllListeners()
removeAllListeners(
event?):void
Defined in: node_modules/achievements-engine/dist/index.d.ts:41
Remove all listeners for a specific event, or all events if no event specified
Parameters
event?
string
Optional event name. If not provided, removes all listeners.
Returns
void
Inherited from
EventEmitter.removeAllListeners
reset()
reset():
void
Defined in: node_modules/achievements-engine/dist/index.d.ts:348
Reset all achievement data
Returns
void
update()
update<
T>(newMetrics):AchievementUpdateResult
Defined in: node_modules/achievements-engine/dist/index.d.ts:309
Update metrics and evaluate achievements
Type Parameters
T
T extends Record<string, any>
Parameters
newMetrics
Partial<T>
Metrics to update