AchievementEngine
Defined in: node_modules/achievements-engine/dist/index.d.ts:249
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:256
Parameters
config
Returns
AchievementEngine
Overrides
EventEmitter.constructor
Methods
destroy()
destroy():
void
Defined in: node_modules/achievements-engine/dist/index.d.ts:312
Clean up resources and event listeners
Returns
void
emit()
emit<
T>(eventName,data?):void
Defined in: node_modules/achievements-engine/dist/index.d.ts:278
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:316
Export achievement data as JSON string
Returns
string
getAllAchievements()
getAllAchievements():
AchievementWithStatus[]
Defined in: node_modules/achievements-engine/dist/index.d.ts:304
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:296
Get current metrics (readonly to prevent external modification)
Type Parameters
T
T extends Record<string, any>
Returns
Readonly<Partial<T>>
getUnlocked()
getUnlocked(): readonly
string[]
Defined in: node_modules/achievements-engine/dist/index.d.ts:300
Get unlocked achievement IDs (readonly)
Returns
readonly string[]
import()
import(
jsonString,options?):ImportResult
Defined in: node_modules/achievements-engine/dist/index.d.ts:322
Import achievement data from JSON string
Parameters
jsonString
string
Exported achievement data
options?
Import options
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:340
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:328
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:334
Subscribe to an event once
Parameters
event
Event name
handler
(data) => void
Event handler
Returns
Overrides
EventEmitter.once
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:308
Reset all achievement data
Returns
void
update()
update<
T>(newMetrics):void
Defined in: node_modules/achievements-engine/dist/index.d.ts:283
Update metrics and evaluate achievements
Type Parameters
T
T extends Record<string, any>
Parameters
newMetrics
Partial<T>
Metrics to update
Returns
void