1 line
6.6 KiB
JavaScript
1 line
6.6 KiB
JavaScript
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 "Interface: UpgradeOptions""></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 "Properties""></a></h2><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to "classes""></a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>boolean</code>>></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 "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/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 "display""></a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<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> }></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 "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/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 "mark""></a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code> | <code>boolean</code>></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 "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/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 "onPurchase""></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="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L69" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:69</a></p><hr><h3 id="requirements" tabindex="-1">requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to "requirements""></a></h3><p>• <strong>requirements</strong>: <a href="./../../../modules/game/requirements#requirements"><code>Requirements</code></a></p><p>The requirements to purchase this upgrade.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L67" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:67</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to "style""></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to this feature.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L51" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:51</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code> | <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this clickable should be visible.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L47" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:47</a></p>',45),d=[s];function i(n,c,u,p,l,f){return r(),a("div",null,d)}const b=e(o,[["render",i]]);export{g as __pageData,b as default};
|