import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: BaseUpgrade","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/upgrades/upgrade.BaseUpgrade.md","lastUpdated":null}'),o={name:"api/interfaces/features/upgrades/upgrade.BaseUpgrade.md"},n=t('<h1 id="interface-baseupgrade" tabindex="-1">Interface: BaseUpgrade <a class="header-anchor" href="#interface-baseupgrade" aria-label="Permalink to &quot;Interface: BaseUpgrade&quot;">​</a></h1><p><a href="./../../../modules/features/upgrades/upgrade">features/upgrades/upgrade</a>.BaseUpgrade</p><p>The properties that are added onto a processed <a href="./upgrade.UpgradeOptions">UpgradeOptions</a> to create an <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="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to &quot;[Component]&quot;">​</a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render 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/70cda5f/src/features/upgrades/upgrade.ts#L87" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:87</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to &quot;[GatherProps]&quot;">​</a></h3><p>• <strong>[GatherProps]</strong>: () =&gt; <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>unknown</code>&gt;</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (): <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>unknown</code>&gt;</p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><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>unknown</code>&gt;</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/70cda5f/src/features/upgrades/upgrade.ts#L89" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:89</a></p><hr><h3 id="bought" tabindex="-1">bought <a class="header-anchor" href="#bought" aria-label="Permalink to &quot;bought&quot;">​</a></h3><p>• <strong>bought</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not this upgrade has been purchased.</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/70cda5f/src/features/upgrades/upgrade.ts#L79" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:79</a></p><hr><h3 id="canpurchase" tabindex="-1">canPurchase <a class="header-anchor" href="#canpurchase" aria-label="Permalink to &quot;canPurchase&quot;">​</a></h3><p>• <strong>canPurchase</strong>: <code>Ref</code>&lt;<code>boolean</code>&gt;</p><p>Whether or not the upgrade can currently be purchased.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L81" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:81</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;">​</a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L77" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:77</a></p><hr><h3 id="purchase" tabindex="-1">purchase <a class="header-anchor" href="#purchase" aria-label="Permalink to &quot;purchase&quot;">​</a></h3><p>• <strong>purchase</strong>: <code>VoidFunction</code></p><p>Purchase the upgrade</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L83" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:83</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to &quot;type&quot;">​</a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/upgrades/upgrade#upgradetype"><code>UpgradeType</code></a></p><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/upgrades/upgrade.ts#L85" target="_blank" rel="noreferrer">profectus/src/features/upgrades/upgrade.ts:85</a></p>',49),s=[n];function d(p,i,c,u,h,f){return r(),a("div",null,s)}const b=e(o,[["render",d]]);export{g as __pageData,b as default};