profectus-docs/assets/api_modules_features_upgrades_upgrade.md.ba1dc944.js

import{_ as e,c as t,o as a,a as d}from"./app.e5a3543f.js";const f='{"title":"Module: features/upgrades/upgrade","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"GenericUpgrade","slug":"genericupgrade"},{"level":3,"title":"Upgrade","slug":"upgrade"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"UpgradeType","slug":"upgradetype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createUpgrade","slug":"createupgrade"},{"level":3,"title":"setupAutoPurchase","slug":"setupautopurchase"}],"relativePath":"api/modules/features/upgrades/upgrade.md"}',r={},o=d('<h1 id="module-features-upgrades-upgrade" tabindex="-1">Module: features/upgrades/upgrade <a class="header-anchor" href="#module-features-upgrades-upgrade" aria-hidden="true">#</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../../interfaces/features/upgrades/upgrade.BaseUpgrade">BaseUpgrade</a></li><li><a href="../../../interfaces/features/upgrades/upgrade.UpgradeOptions">UpgradeOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="genericupgrade" tabindex="-1">GenericUpgrade <a class="header-anchor" href="#genericupgrade" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericUpgrade</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./upgrade.html#upgrade"><code>Upgrade</code></a>&lt;<a href="../../../interfaces/features/upgrades/upgrade.UpgradeOptions"><code>UpgradeOptions</code></a>&gt;, { <code>canPurchase</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&gt;</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/upgrades/upgrade.ts#L73" target="_blank" rel="noopener noreferrer">profectus/src/features/upgrades/upgrade.ts:73</a></p><hr><h3 id="upgrade" tabindex="-1">Upgrade <a class="header-anchor" href="#upgrade" aria-hidden="true">#</a></h3><p>\u01AC <strong>Upgrade</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/upgrades/upgrade.BaseUpgrade"><code>BaseUpgrade</code></a>, { <code>canAfford</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;canAfford&quot;</code>], <code>Ref</code>&lt;<code>boolean</code>&gt;&gt; ; <code>classes</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>cost</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;cost&quot;</code>]&gt; ; <code>display</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>mark</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;mark&quot;</code>]&gt; ; <code>style</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/upgrades/upgrade.UpgradeOptions"><code>UpgradeOptions</code></a></td></tr></tbody></table><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/upgrades/upgrade.ts#L60" target="_blank" rel="noopener noreferrer">profectus/src/features/upgrades/upgrade.ts:60</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="upgradetype" tabindex="-1">UpgradeType <a class="header-anchor" href="#upgradetype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>UpgradeType</strong>: typeof <a href="./upgrade.html#upgradetype"><code>UpgradeType</code></a></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/upgrades/upgrade.ts#L29" target="_blank" rel="noopener noreferrer">profectus/src/features/upgrades/upgrade.ts:29</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createupgrade" tabindex="-1">createUpgrade <a class="header-anchor" href="#createupgrade" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createUpgrade</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./upgrade.html#upgrade"><code>Upgrade</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/upgrades/upgrade.UpgradeOptions"><code>UpgradeOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>optionsFunc</code></td><td style="text-align:left;"><a href="./../feature.html#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="./upgrade.html#upgrade"><code>Upgrade</code></a>&lt;<code>T</code>&gt;, <a href="../../../interfaces/features/upgrades/upgrade.BaseUpgrade"><code>BaseUpgrade</code></a>&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./upgrade.html#upgrade"><code>Upgrade</code></a>&lt;<code>T</code>&gt;</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/upgrades/upgrade.ts#L81" target="_blank" rel="noopener noreferrer">profectus/src/features/upgrades/upgrade.ts:81</a></p><hr><h3 id="setupautopurchase" tabindex="-1">setupAutoPurchase <a class="header-anchor" href="#setupautopurchase" aria-hidden="true">#</a></h3><p>\u25B8 <strong>setupAutoPurchase</strong>(<code>layer</code>, <code>autoActive</code>, <code>upgrades?</code>): <code>void</code></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>layer</code></td><td style="text-align:left;"><a href="./../../game/layers.html#genericlayer"><code>GenericLayer</code></a></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>autoActive</code></td><td style="text-align:left;"><a href="./../../util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>upgrades</code></td><td style="text-align:left;"><a href="./upgrade.html#genericupgrade"><code>GenericUpgrade</code></a>[]</td><td style="text-align:left;"><code>[]</code></td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><code>void</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/upgrades/upgrade.ts#L174" target="_blank" rel="noopener noreferrer">profectus/src/features/upgrades/upgrade.ts:174</a></p>',40),c=[o];function s(l,i,p,u,n,h){return a(),t("div",null,c)}var b=e(r,[["render",s]]);export{f as __pageData,b as default};