AchievementBuilder
Defined in: node_modules/achievements-engine/dist/index.d.ts:783
Main AchievementBuilder with three-tier API Tier 1: Simple static methods with smart defaults Tier 2: Chainable customization Tier 3: Full builder for complex logic
Constructors
Constructor
new AchievementBuilder():
AchievementBuilder
Returns
AchievementBuilder
Methods
combine()
staticcombine(achievements):SimpleAchievementConfig
Defined in: node_modules/achievements-engine/dist/index.d.ts:831
Combine multiple achievement configurations
Parameters
achievements
(SimpleAchievementConfig | Achievement)[]
Array of SimpleAchievementConfig objects or Achievement instances
Returns
SimpleAchievementConfig
Combined SimpleAchievementConfig
create()
staticcreate():ComplexAchievementBuilder
Defined in: node_modules/achievements-engine/dist/index.d.ts:825
Create a complex achievement builder for power users
Returns
ComplexAchievementBuilder
ComplexAchievementBuilder for full control
createBooleanAchievement()
staticcreateBooleanAchievement(metric):BooleanAchievement
Defined in: node_modules/achievements-engine/dist/index.d.ts:813
Create a boolean achievement with smart defaults
Parameters
metric
string
The metric name (e.g., 'completedTutorial')
Returns
BooleanAchievement
Chainable BooleanAchievement
createLevelAchievement()
staticcreateLevelAchievement(level):ThresholdAchievement
Defined in: node_modules/achievements-engine/dist/index.d.ts:801
Create a single level achievement with smart defaults
Parameters
level
number
Level threshold to achieve
Returns
ThresholdAchievement
Chainable ThresholdAchievement
createLevelAchievements()
staticcreateLevelAchievements(levels):SimpleAchievementConfig
Defined in: node_modules/achievements-engine/dist/index.d.ts:807
Create multiple level achievements
Parameters
levels
(number | [number, AwardDetails])[]
Array of levels or [level, award] tuples
Returns
SimpleAchievementConfig
Complete SimpleAchievementConfig
createScoreAchievement()
staticcreateScoreAchievement(threshold):ThresholdAchievement
Defined in: node_modules/achievements-engine/dist/index.d.ts:789
Create a single score achievement with smart defaults
Parameters
threshold
number
Score threshold to achieve
Returns
ThresholdAchievement
Chainable ThresholdAchievement
createScoreAchievements()
staticcreateScoreAchievements(thresholds):SimpleAchievementConfig
Defined in: node_modules/achievements-engine/dist/index.d.ts:795
Create multiple score achievements
Parameters
thresholds
(number | [number, AwardDetails])[]
Array of thresholds or [threshold, award] tuples
Returns
SimpleAchievementConfig
Complete SimpleAchievementConfig
createValueAchievement()
staticcreateValueAchievement(metric,value):ValueAchievement
Defined in: node_modules/achievements-engine/dist/index.d.ts:820
Create a value-based achievement with smart defaults
Parameters
metric
string
The metric name (e.g., 'characterClass')
value
string
The value to match (e.g., 'wizard')
Returns
ValueAchievement
Chainable ValueAchievement