Profectus

Profectus / features/achievements/achievement / AchievementOptions

Interface: AchievementOptions ​

An object that configures an Achievement.

Extends ​

Properties ​

classes? ​

optional classes: MaybeRefOrGetter<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeatureOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24

display? ​

optional display: MaybeGetter<Renderable> | { effectDisplay: MaybeGetter<Renderable> | undefined; optionsDisplay: MaybeGetter<Renderable> | undefined; requirement: MaybeGetter<Renderable> | undefined; }

The display to use for this achievement.

Type declaration ​

MaybeGetter<Renderable>

{ effectDisplay: MaybeGetter<Renderable> | undefined; optionsDisplay: MaybeGetter<Renderable> | undefined; requirement: MaybeGetter<Renderable> | undefined; }

effectDisplay? ​

optional effectDisplay: MaybeGetter<Renderable> | undefined

Description of what will change (if anything) for achieving this.

optionsDisplay? ​

optional optionsDisplay: MaybeGetter<Renderable> | undefined

Any additional things to display on this achievement, such as a toggle for it's effect.

requirement? ​

optional requirement: MaybeGetter<Renderable> | undefined

Description of the requirement(s) for this achievement. If unspecified then the requirements will be displayed automatically based on requirements.

Defined in ​

profectus/src/features/achievements/achievement.tsx:130

image? ​

optional image: MaybeRefOrGetter<string>

An image to display as the background for this achievement.

Defined in ​

profectus/src/features/achievements/achievement.tsx:143

onComplete? ​

optional onComplete: VoidFunction

A function that is called when the achievement is completed.

Defined in ​

profectus/src/features/achievements/achievement.tsx:147

requirements? ​

optional requirements: Requirements

The requirement(s) to earn this achievement. Can be left null if using Achievement.complete.

Defined in ​

profectus/src/features/achievements/achievement.tsx:128

showPopups? ​

optional showPopups: MaybeRefOrGetter<boolean>

Whether or not to display a notification popup when this achievement is earned.

Defined in ​

profectus/src/features/achievements/achievement.tsx:145

small? ​

optional small: MaybeRefOrGetter<boolean>

Toggles a smaller design for the feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:141

style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeatureOptions.style

Defined in ​

profectus/src/util/vue.tsx:26

visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeatureOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22