import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Module: features/upgrades/upgrade","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/upgrades/upgrade.md","lastUpdated":null}'),d={name:"api/modules/features/upgrades/upgrade.md"},o=r('
Ƭ GenericUpgrade: Replace
<Upgrade
<UpgradeOptions
>, { visibility
: ProcessedComputable
<Visibility
| boolean
> }>
A type that matches any valid Upgrade object.
profectus/src/features/upgrades/upgrade.ts:106
Ƭ Upgrade<T
>: Replace
<T
& BaseUpgrade
, { classes
: GetComputableType
<T
["classes"
]> ; display
: GetComputableType
<T
["display"
]> ; mark
: GetComputableType
<T
["mark"
]> ; requirements
: GetComputableType
<T
["requirements"
]> ; style
: GetComputableType
<T
["style"
]> ; visibility
: GetComputableTypeWithDefault
<T
["visibility"
], Visible
> }>
An object that represents a feature that can be purchased a single time.
Name | Type |
---|---|
T | extends UpgradeOptions |
profectus/src/features/upgrades/upgrade.ts:93
• Const
UpgradeType: typeof UpgradeType
A symbol used to identify Upgrade features.
profectus/src/features/upgrades/upgrade.ts:40
▸ createUpgrade<T
>(optionsFunc
): Upgrade
<T
>
Lazily creates an upgrade with the given options.
Name | Type |
---|---|
T | extends UpgradeOptions |
Name | Type | Description |
---|---|---|
optionsFunc | OptionsFunc <T , BaseUpgrade , GenericUpgrade > | Upgrade options. |
Upgrade
<T
>
profectus/src/features/upgrades/upgrade.ts:117
▸ setupAutoPurchase(layer
, autoActive
, upgrades?
): void
Utility to auto purchase a list of upgrades whenever they're affordable.
Name | Type | Default value | Description |
---|---|---|---|
layer | GenericLayer | undefined | The layer the upgrades are apart of |
autoActive | Computable <boolean > | undefined | Whether or not the upgrades should currently be auto-purchasing |
upgrades | GenericUpgrade [] | [] | The specific upgrades to upgrade. If unspecified, uses all upgrades on the layer. |
void