Profectus

Profectus / features/clickables/upgrade / UpgradeOptions

Interface: UpgradeOptions ​

An object that configures a Upgrade.

Extends ​

Properties ​

canClick? ​

optional canClick: MaybeRefOrGetter<boolean>

Whether or not the clickable may be clicked.

Inherited from ​

ClickableOptions.canClick

Defined in ​

profectus/src/features/clickables/clickable.tsx:39

classes? ​

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

Dictionary of CSS classes to apply to this feature.

Inherited from ​

ClickableOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24

display? ​

optional display: MaybeGetter<Renderable> | { description: MaybeGetter<Renderable>; effectDisplay: MaybeGetter<Renderable> | undefined; title: MaybeGetter<Renderable> | undefined; }

The display to use for this upgrade.

Type declaration ​

MaybeGetter<Renderable>

{ description: MaybeGetter<Renderable>; effectDisplay: MaybeGetter<Renderable> | undefined; title: MaybeGetter<Renderable> | undefined; }

description ​

description: MaybeGetter<Renderable>

The main text that appears in the display.

effectDisplay? ​

optional effectDisplay: MaybeGetter<Renderable> | undefined

A description of the current effect of the achievement. Useful when the effect changes dynamically.

title? ​

optional title: MaybeGetter<Renderable> | undefined

A header to appear at the top of the display.

Overrides ​

ClickableOptions.display

Defined in ​

profectus/src/features/clickables/upgrade.tsx:62

onClick()? ​

optional onClick: (e?) => void

A function that is called when the clickable is clicked.

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Inherited from ​

ClickableOptions.onClick

Defined in ​

profectus/src/features/clickables/clickable.tsx:50

onHold? ​

optional onHold: VoidFunction

A function that is called when the clickable is held down.

Inherited from ​

ClickableOptions.onHold

Defined in ​

profectus/src/features/clickables/clickable.tsx:52

onPurchase? ​

optional onPurchase: VoidFunction

A function that is called when the upgrade is purchased.

Defined in ​

profectus/src/features/clickables/upgrade.tsx:75

requirements ​

requirements: Requirements

The requirements to purchase this upgrade.

Defined in ​

profectus/src/features/clickables/upgrade.tsx:73

style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

ClickableOptions.style

Defined in ​

profectus/src/util/vue.tsx:26

visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

ClickableOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22