1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
import{_ as a,c as t,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const u=JSON.parse('{"title":"Interface: ResetButtonOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/data/common/interfaces/ResetButtonOptions.md","filePath":"api/data/common/interfaces/ResetButtonOptions.md","lastUpdated":null}'),i={name:"api/data/common/interfaces/ResetButtonOptions.md"};function n(c,e,s,l,d,h){return o(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../">Profectus</a> / <a href="./../">data/common</a> / ResetButtonOptions</p><h1 id="interface-resetbuttonoptions" tabindex="-1">Interface: ResetButtonOptions <a class="header-anchor" href="#interface-resetbuttonoptions" aria-label="Permalink to "Interface: ResetButtonOptions""></a></h1><p>An object that configures a <a href="./ResetButton">ResetButton</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="./../../../features/clickables/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 this button can currently be clicked. Defaults to checking the current gain amount is greater than <a href="./ResetButtonOptions#minimumgain">minimumGain</a></p><h4 id="overrides" tabindex="-1">Overrides <a class="header-anchor" href="#overrides" aria-label="Permalink to "Overrides""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/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/data/common.tsx#L51" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:51</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" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/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="conversion" tabindex="-1">conversion <a class="header-anchor" href="#conversion" aria-label="Permalink to "conversion""></a></h3><blockquote><p><strong>conversion</strong>: <a href="./../../../features/conversion/interfaces/Conversion"><code>Conversion</code></a></p></blockquote><p>The conversion the button uses to calculate how much resources will be gained on click</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/data/common.tsx#L30" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:30</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>></p></blockquote><p>The content to display on the button. By default, this includes the reset description, and amount of currency to be gained.</p><h4 id="overrides-1" tabindex="-1">Overrides <a class="header-anchor" href="#overrides-1" aria-label="Permalink to "Overrides""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/clickable/interfaces/ClickableOptions#display"><code>display</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/data/common.tsx#L46" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:46</a></p><hr><h3 id="minimumgain" tabindex="-1">minimumGain? <a class="header-anchor" href="#minimumgain" aria-label="Permalink to "minimumGain?""></a></h3><blockquote><p><code>optional</code> <strong>minimumGain</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>When <a href="./ResetButtonOptions#canclick">canClick</a> is left to its default, minimumGain is used to only enable the reset button when a sufficient amount of currency to gain is available.</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/data/common.tsx#L55" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:55</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-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/clickable/interfaces/ClickableOptions#onclick"><code>onClick</code></a></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/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-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/clickable/interfaces/ClickableOptions#onhold"><code>onHold</code></a></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/clickable.tsx#L37" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:37</a></p><hr><h3 id="resetdescription" tabindex="-1">resetDescription? <a class="header-anchor" href="#resetdescription" aria-label="Permalink to "resetDescription?""></a></h3><blockquote><p><code>optional</code> <strong>resetDescription</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>Text to display on low conversion amounts, describing what "resetting" is in this context. Defaults to "Reset for ".</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/data/common.tsx#L39" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:39</a></p><hr><h3 id="resettime" tabindex="-1">resetTime? <a class="header-anchor" href="#resettime" aria-label="Permalink to "resetTime?""></a></h3><blockquote><p><code>optional</code> <strong>resetTime</strong>: <a href="./../../../game/persistence/type-aliases/Persistent"><code>Persistent</code></a><<a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>A persistent ref to track how much time has passed since the last time this tree node was reset.</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/data/common.tsx#L57" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:57</a></p><hr><h3 id="shownextat" tabindex="-1">showNextAt? <a class="header-anchor" href="#shownextat" aria-label="Permalink to "showNextAt?""></a></h3><blockquote><p><code>optional</code> <strong>showNextAt</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 to show how much currency would be required to make the gain amount increase.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/data/common.tsx#L41" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:41</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-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/clickable/interfaces/ClickableOptions#style"><code>style</code></a></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" 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="tree" tabindex="-1">tree <a class="header-anchor" href="#tree" aria-label="Permalink to "tree""></a></h3><blockquote><p><strong>tree</strong>: <a href="./../../../features/trees/tree/interfaces/Tree"><code>Tree</code></a></p></blockquote><p>The tree this reset button is apart of</p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/data/common.tsx#L32" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:32</a></p><hr><h3 id="treenode" tabindex="-1">treeNode <a class="header-anchor" href="#treenode" aria-label="Permalink to "treeNode""></a></h3><blockquote><p><strong>treeNode</strong>: <a href="./../../../features/trees/tree/interfaces/TreeNode"><code>TreeNode</code></a></p></blockquote><p>The specific tree node associated with this reset button</p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/data/common.tsx#L34" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:34</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-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../features/clickables/clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>.<a href="./../../../features/clickables/clickable/interfaces/ClickableOptions#visibility"><code>visibility</code></a></p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" 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>',108)]))}const p=a(i,[["render",n]]);export{u as __pageData,p as default};
|