1 line
14 KiB
JavaScript
1 line
14 KiB
JavaScript
import{_ as a,c as t,a0 as r,o as i}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: UpgradeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/clickables/upgrade/interfaces/UpgradeOptions.md","filePath":"api/features/clickables/upgrade/interfaces/UpgradeOptions.md","lastUpdated":null}'),o={name:"api/features/clickables/upgrade/interfaces/UpgradeOptions.md"};function c(l,e,n,s,d,h){return i(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/clickables/upgrade</a> / UpgradeOptions</p><h1 id="interface-upgradeoptions" tabindex="-1">Interface: UpgradeOptions <a class="header-anchor" href="#interface-upgradeoptions" aria-label="Permalink to "Interface: UpgradeOptions""></a></h1><p>An object that configures a <a href="./Upgrade">Upgrade</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="canclick" tabindex="-1">canClick? <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick?""></a></h3><blockquote><p><code>optional</code> <strong>canClick</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><p>Whether or not the clickable may be clicked.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#canclick"><code>canClick</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/clickable.tsx#L24" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:24</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#classes"><code>classes</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="display" tabindex="-1">display? <a class="header-anchor" href="#display" aria-label="Permalink to "display?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>> | { <code>description</code>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>>; <code>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>title</code>: MaybeGetter<Renderable> | undefined; }</p></blockquote><p>The display to use for this upgrade.</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p><a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p><p>{ <code>description</code>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>>; <code>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>title</code>: MaybeGetter<Renderable> | undefined; }</p><h4 id="description" tabindex="-1">description <a class="header-anchor" href="#description" aria-label="Permalink to "description""></a></h4><blockquote><p><strong>description</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><p>The main text that appears in the display.</p><h4 id="effectdisplay" tabindex="-1">effectDisplay? <a class="header-anchor" href="#effectdisplay" aria-label="Permalink to "effectDisplay?""></a></h4><blockquote><p><code>optional</code> <strong>effectDisplay</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A description of the current effect of the achievement. Useful when the effect changes dynamically.</p><h4 id="title" tabindex="-1">title? <a class="header-anchor" href="#title" aria-label="Permalink to "title?""></a></h4><blockquote><p><code>optional</code> <strong>title</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A header to appear at the top of the display.</p><h4 id="overrides" tabindex="-1">Overrides <a class="header-anchor" href="#overrides" aria-label="Permalink to "Overrides""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#display"><code>display</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/upgrade.tsx#L36" target="_blank" rel="noreferrer">profectus/src/features/clickables/upgrade.tsx:36</a></p><hr><h3 id="onclick" tabindex="-1">onClick()? <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick()?""></a></h3><blockquote><p><code>optional</code> <strong>onClick</strong>: (<code>e</code>?) => <code>void</code></p></blockquote><p>A function that is called when the clickable is clicked.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="e" tabindex="-1">e? <a class="header-anchor" href="#e" aria-label="Permalink to "e?""></a></h5><p><a href="https://developer.mozilla.org/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#onclick"><code>onClick</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/clickable.tsx#L35" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:35</a></p><hr><h3 id="onhold" tabindex="-1">onHold? <a class="header-anchor" href="#onhold" aria-label="Permalink to "onHold?""></a></h3><blockquote><p><code>optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the clickable is held down.</p><h4 id="inherited-from-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#onhold"><code>onHold</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/clickable.tsx#L37" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:37</a></p><hr><h3 id="onpurchase" tabindex="-1">onPurchase? <a class="header-anchor" href="#onpurchase" aria-label="Permalink to "onPurchase?""></a></h3><blockquote><p><code>optional</code> <strong>onPurchase</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the upgrade is purchased.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/upgrade.tsx#L49" target="_blank" rel="noreferrer">profectus/src/features/clickables/upgrade.tsx:49</a></p><hr><h3 id="requirements" tabindex="-1">requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to "requirements""></a></h3><blockquote><p><strong>requirements</strong>: <a href="./../../../../game/requirements/type-aliases/Requirements"><code>Requirements</code></a></p></blockquote><p>The requirements to purchase this upgrade.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/upgrade.tsx#L47" target="_blank" rel="noreferrer">profectus/src/features/clickables/upgrade.tsx:47</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this feature.</p><h4 id="inherited-from-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#style"><code>style</code></a></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-5" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-5" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../clickable/interfaces/ClickableOptions#visibility"><code>visibility</code></a></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',90)]))}const u=a(o,[["render",c]]);export{f as __pageData,u as default};
|