ProfectusInterface: AchievementOptions
features/achievements/achievement.AchievementOptions
An object that configures an Achievement.
Properties
classes
• Optional classes: Computable<Record<string, boolean>>
Dictionary of CSS classes to apply to this feature.
Defined in
profectus/src/features/achievements/achievement.tsx:87
display
• Optional display: Computable<CoercableComponent | { effectDisplay?: CoercableComponent ; optionsDisplay?: CoercableComponent ; requirement?: CoercableComponent }>
The display to use for this achievement.
Defined in
profectus/src/features/achievements/achievement.tsx:67
image
• Optional image: Computable<string>
An image to display as the background for this achievement.
Defined in
profectus/src/features/achievements/achievement.tsx:83
mark
• Optional mark: Computable<string | boolean>
Shows a marker on the corner of the feature.
Defined in
profectus/src/features/achievements/achievement.tsx:79
onComplete
• Optional onComplete: VoidFunction
A function that is called when the achievement is completed.
Defined in
profectus/src/features/achievements/achievement.tsx:91
requirements
• Optional requirements: Requirements
The requirement(s) to earn this achievement. Can be left null if using complete.
Defined in
profectus/src/features/achievements/achievement.tsx:65
showPopups
• Optional showPopups: Computable<boolean>
Whether or not to display a notification popup when this achievement is earned.
Defined in
profectus/src/features/achievements/achievement.tsx:89
small
• Optional small: Computable<boolean>
Toggles a smaller design for the feature.
Defined in
profectus/src/features/achievements/achievement.tsx:81
style
• Optional style: Computable<StyleValue>
CSS to apply to this feature.
Defined in
profectus/src/features/achievements/achievement.tsx:85
visibility
• Optional visibility: Computable<boolean | Visibility>
Whether this achievement should be visible.