Skip to content

Profectus / features/clickables/upgrade / Upgrade

Interface: Upgrade ​

An object that represents a feature that can be purchased a single time.

Extends ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

VueFeature.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43


bought ​

bought: Persistent<boolean>

Whether or not this upgrade has been purchased.

Defined in ​

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


canPurchase ​

canPurchase: Ref<boolean, boolean>

Whether or not the upgrade can currently be purchased.

Defined in ​

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


classes? ​

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

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeature.classes

Defined in ​

profectus/src/util/vue.tsx:35


components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

VueFeature.components

Defined in ​

profectus/src/util/vue.tsx:39


display? ​

optional display: MaybeGetter<Renderable>

The display to use for this upgrade.

Defined in ​

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


id ​

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Inherited from ​

VueFeature.id

Defined in ​

profectus/src/util/vue.tsx:31


onPurchase? ​

optional onPurchase: VoidFunction

A function that is called when the upgrade is purchased.

Defined in ​

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


purchase ​

purchase: VoidFunction

Purchase the upgrade

Defined in ​

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


requirements ​

requirements: Requirements

The requirements to purchase this upgrade.

Defined in ​

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


style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeature.style

Defined in ​

profectus/src/util/vue.tsx:37


type ​

type: typeof UpgradeType

A symbol that helps identify features of the same type.

Defined in ​

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


visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeature.visibility

Defined in ​

profectus/src/util/vue.tsx:33


wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

VueFeature.wrappers

Defined in ​

profectus/src/util/vue.tsx:41