profectus-docs/assets/api_features_clickables_upgrade_functions_setupAutoPurchase.md.BoLgT7bm.js

1 line
2.7 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as a,c as r,a0 as t,o}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Function: setupAutoPurchase()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/clickables/upgrade/functions/setupAutoPurchase.md","filePath":"api/features/clickables/upgrade/functions/setupAutoPurchase.md","lastUpdated":null}'),s={name:"api/features/clickables/upgrade/functions/setupAutoPurchase.md"};function u(c,e,i,d,n,p){return o(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/clickables/upgrade</a> / setupAutoPurchase</p><h1 id="function-setupautopurchase" tabindex="-1">Function: setupAutoPurchase() <a class="header-anchor" href="#function-setupautopurchase" aria-label="Permalink to &quot;Function: setupAutoPurchase()&quot;"></a></h1><blockquote><p><strong>setupAutoPurchase</strong>(<code>layer</code>, <code>autoActive</code>, <code>upgrades</code>): <code>void</code></p></blockquote><p>Utility to auto purchase a list of upgrades whenever they&#39;re affordable.</p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="layer" tabindex="-1">layer <a class="header-anchor" href="#layer" aria-label="Permalink to &quot;layer&quot;"></a></h3><p><a href="./../../../../game/layers/interfaces/Layer"><code>Layer</code></a></p><p>The layer the upgrades are apart of</p><h3 id="autoactive" tabindex="-1">autoActive <a class="header-anchor" href="#autoactive" aria-label="Permalink to &quot;autoActive&quot;"></a></h3><p><a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not the upgrades should currently be auto-purchasing</p><h3 id="upgrades" tabindex="-1">upgrades <a class="header-anchor" href="#upgrades" aria-label="Permalink to &quot;upgrades&quot;"></a></h3><p><a href="./../interfaces/Upgrade"><code>Upgrade</code></a>[] = <code>[]</code></p><p>The specific upgrades to upgrade. If unspecified, uses all upgrades on the layer.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><code>void</code></p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/upgrade.tsx#L160" target="_blank" rel="noreferrer">profectus/src/features/clickables/upgrade.tsx:160</a></p>',18)]))}const f=a(s,[["render",u]]);export{h as __pageData,f as default};