import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Interface: AchievementOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/achievements/achievement.AchievementOptions.md","lastUpdated":null}'),r={name:"api/interfaces/features/achievements/achievement.AchievementOptions.md"},i=o('
features/achievements/achievement.AchievementOptions
An object that configures an Achievement.
• Optional
classes: Computable
<Record
<string
, boolean
>>
Dictionary of CSS classes to apply to this feature.
profectus/src/features/achievements/achievement.tsx:87
• Optional
display: Computable
<CoercableComponent
| { effectDisplay?
: CoercableComponent
; optionsDisplay?
: CoercableComponent
; requirement?
: CoercableComponent
}>
The display to use for this achievement.
profectus/src/features/achievements/achievement.tsx:67
• Optional
image: Computable
<string
>
An image to display as the background for this achievement.
profectus/src/features/achievements/achievement.tsx:83
• Optional
mark: Computable
<string
| boolean
>
Shows a marker on the corner of the feature.
profectus/src/features/achievements/achievement.tsx:79
• Optional
onComplete: VoidFunction
A function that is called when the achievement is completed.
profectus/src/features/achievements/achievement.tsx:91
• Optional
requirements: Requirements
The requirement(s) to earn this achievement. Can be left null if using complete.
profectus/src/features/achievements/achievement.tsx:65
• Optional
showPopups: Computable
<boolean
>
Whether or not to display a notification popup when this achievement is earned.
profectus/src/features/achievements/achievement.tsx:89
• Optional
small: Computable
<boolean
>
Toggles a smaller design for the feature.
profectus/src/features/achievements/achievement.tsx:81
• Optional
style: Computable
<StyleValue
>
CSS to apply to this feature.
profectus/src/features/achievements/achievement.tsx:85
• Optional
visibility: Computable
<boolean
| Visibility
>
Whether this achievement should be visible.