Profectus / features/achievements/achievement / Achievement
Interface: Achievement ​
An object that represents a feature with requirements that is passively earned upon meeting certain requirements.
Extends ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
complete ​
complete:
VoidFunction
A function to complete this achievement.
Defined in ​
profectus/src/features/achievements/achievement.tsx:89
components ​
components:
MaybeGetter<Renderable>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
display? ​
optionaldisplay:MaybeGetter<Renderable>
The display to use for this achievement.
Defined in ​
profectus/src/features/achievements/achievement.tsx:79
earned ​
earned:
Persistent<boolean>
Whether or not this achievement has been earned.
Defined in ​
profectus/src/features/achievements/achievement.tsx:87
id ​
id:
string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Inherited from ​
Defined in ​
image? ​
optionalimage:MaybeRef<string>
An image to display as the background for this achievement.
Defined in ​
profectus/src/features/achievements/achievement.tsx:83
onComplete? ​
optionalonComplete:VoidFunction
A function that is called when the achievement is completed.
Defined in ​
profectus/src/features/achievements/achievement.tsx:77
requirements? ​
optionalrequirements:Requirements
The requirement(s) to earn this achievement.
Defined in ​
profectus/src/features/achievements/achievement.tsx:75
showPopups ​
showPopups:
MaybeRef<boolean>
Whether or not to display a notification popup when this achievement is earned.
Defined in ​
profectus/src/features/achievements/achievement.tsx:85
small? ​
optionalsmall:MaybeRef<boolean>
Toggles a smaller design for the feature.
Defined in ​
profectus/src/features/achievements/achievement.tsx:81
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
type ​
type: typeof
AchievementType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/achievements/achievement.tsx:91
visibility? ​
optionalvisibility:MaybeRef<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
wrappers ​
wrappers:
Wrapper[]
The components to render wrapped around the vue feature