Profectus
On this page

Interface: UpgradeOptions ​

features/upgrades/upgrade.UpgradeOptions

An object that configures a Upgrade.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

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

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; effectDisplay?: CoercableComponent ; title?: CoercableComponent }>

The display to use for this clickable.

Defined in ​

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

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

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

onPurchase ​

• Optional onPurchase: VoidFunction

A function that is called when the upgrade is purchased.

Defined in ​

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

requirements ​

• requirements: Requirements

The requirements to purchase this upgrade.

Defined in ​

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

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

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

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

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