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 ​
Defined in ​
bought ​
bought:
Persistent<boolean>
Whether or not this upgrade has been purchased.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:85
canPurchase ​
canPurchase:
Ref<boolean,boolean>
Whether or not the upgrade can currently be purchased.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:87
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
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 upgrade.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:83
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 ​
onPurchase? ​
optionalonPurchase:VoidFunction
A function that is called when the upgrade is purchased.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:89
purchase ​
purchase:
VoidFunction
Purchase the upgrade
Defined in ​
profectus/src/features/clickables/upgrade.tsx:91
requirements ​
requirements:
Requirements
The requirements to purchase this upgrade.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:81
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
type ​
type: typeof
UpgradeType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/clickables/upgrade.tsx:93
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