profectus-docs/assets/api_interfaces_features_upgrades_upgrade.UpgradeOptions.md.eb909b6c.js

import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: UpgradeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/upgrades/upgrade.UpgradeOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/upgrades/upgrade.UpgradeOptions.md"},s=t('<h1 id="interface-upgradeoptions" tabindex="-1">Interface: UpgradeOptions <a class="header-anchor" href="#interface-upgradeoptions" aria-label="Permalink to &quot;Interface: UpgradeOptions&quot;">​</a></h1><p><a href="./../../../modules/features/upgrades/upgrade">features/upgrades/upgrade</a>.UpgradeOptions</p><p>An object that configures a <a href="./../../../modules/features/upgrades/upgrade#upgrade">Upgrade</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes&quot;">​</a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</p><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/upgrades/upgrade.ts#L49" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:49</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;">​</a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> | { <code>description</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>effectDisplay?</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> }&gt;</p><p>The display to use for this clickable.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/upgrades/upgrade.ts#L55" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:55</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to &quot;mark&quot;">​</a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code> | <code>boolean</code>&gt;</p><p>Shows a marker on the corner of the feature.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/features/upgrades/upgrade.ts#L53" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:53</a></p><hr><h3 id="onpurchase" tabindex="-1">onPurchase <a class="header-anchor" href="#onpurchase" aria-label="Permalink to &quot;onPurchase&quot;">​</a></h3><p>• <code>Optional</code> <strong>onPurchase</strong>: <code>VoidFunction</code></p><p>A function that is called when the upgrade is purchased.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="