Skip to content
On this page

Interface: BaseUpgrade

features/upgrades/upgrade.BaseUpgrade

The properties that are added onto a processed UpgradeOptions to create an Upgrade.

Properties

[Component]

[Component]: GenericComponent

The Vue component used to render this feature.

Defined in

profectus/src/features/upgrades/upgrade.ts:87


[GatherProps]

[GatherProps]: () => Record<string, unknown>

Type declaration

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns

Record<string, unknown>

Defined in

profectus/src/features/upgrades/upgrade.ts:89


bought

bought: Persistent<boolean>

Whether or not this upgrade has been purchased.

Defined in

profectus/src/features/upgrades/upgrade.ts:79


canPurchase

canPurchase: Ref<boolean>

Whether or not the upgrade can currently be purchased.

Defined in

profectus/src/features/upgrades/upgrade.ts:81


id

id: string

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

Defined in

profectus/src/features/upgrades/upgrade.ts:77


purchase

purchase: VoidFunction

Purchase the upgrade

Defined in

profectus/src/features/upgrades/upgrade.ts:83


type

type: typeof UpgradeType

A symbol that helps identify features of the same type.

Defined in

profectus/src/features/upgrades/upgrade.ts:85