1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
import{_ as e,c as a,o as t,a as r}from"./app.ab34650d.js";const b=JSON.parse('{"title":"Interface: ResetButtonOptions","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Hierarchy","slug":"hierarchy"},{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"canClick","slug":"canclick"},{"level":3,"title":"classes","slug":"classes"},{"level":3,"title":"conversion","slug":"conversion"},{"level":3,"title":"display","slug":"display"},{"level":3,"title":"mark","slug":"mark"},{"level":3,"title":"minimumGain","slug":"minimumgain"},{"level":3,"title":"onClick","slug":"onclick"},{"level":3,"title":"onHold","slug":"onhold"},{"level":3,"title":"resetDescription","slug":"resetdescription"},{"level":3,"title":"resetTime","slug":"resettime"},{"level":3,"title":"showNextAt","slug":"shownextat"},{"level":3,"title":"small","slug":"small"},{"level":3,"title":"style","slug":"style"},{"level":3,"title":"tree","slug":"tree"},{"level":3,"title":"treeNode","slug":"treenode"},{"level":3,"title":"visibility","slug":"visibility"}],"relativePath":"api/interfaces/data/common.ResetButtonOptions.md","lastUpdated":null}'),i={name:"api/interfaces/data/common.ResetButtonOptions.md"},o=r('<h1 id="interface-resetbuttonoptions" tabindex="-1">Interface: ResetButtonOptions <a class="header-anchor" href="#interface-resetbuttonoptions" aria-hidden="true">#</a></h1><p><a href="./../../modules/data/common.html">data/common</a>.ResetButtonOptions</p><p>An object that configures a <a href="./../../modules/data/common.html#resetbutton">ResetButton</a></p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-hidden="true">#</a></h2><ul><li><p><a href="../features/clickables/clickable.ClickableOptions"><code>ClickableOptions</code></a></p><p>\u21B3 <strong><code>ResetButtonOptions</code></strong></p></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>canClick</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not this button can currently be clicked. Defaults to checking the current gain amount is greater than <a href="./common.ResetButtonOptions.html#minimumgain">minimumGain</a></p><h4 id="overrides" tabindex="-1">Overrides <a class="header-anchor" href="#overrides" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#canclick">canClick</a></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/013092f/src/data/common.tsx#L52" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:52</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>classes</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<code>Record</code><<code>string</code>, <code>boolean</code>>></p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#classes">classes</a></p><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/013092f/src/features/clickables/clickable.ts#L21" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:21</a></p><hr><h3 id="conversion" tabindex="-1">conversion <a class="header-anchor" href="#conversion" aria-hidden="true">#</a></h3><p>\u2022 <strong>conversion</strong>: <a href="./../../modules/features/conversion.html#genericconversion"><code>GenericConversion</code></a></p><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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L31" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:31</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>display</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>></p><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-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#display">display</a></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/013092f/src/data/common.tsx#L47" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:47</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>mark</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<code>string</code> | <code>boolean</code>></p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#mark">mark</a></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/013092f/src/features/clickables/clickable.ts#L23" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:23</a></p><hr><h3 id="minimumgain" tabindex="-1">minimumGain <a class="header-anchor" href="#minimumgain" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>minimumGain</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>></p><p>When <a href="./common.ResetButtonOptions.html#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-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L56" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:56</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>onClick</strong>: (<code>e?</code>: <code>MouseEvent</code> | <code>TouchEvent</code>) => <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</a></h4><p>\u25B8 (<code>e?</code>): <code>void</code></p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h5><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>e?</code></td><td style="text-align:left;"><code>MouseEvent</code> | <code>TouchEvent</code></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h5><p><code>void</code></p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#onclick">onClick</a></p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/clickables/clickable.ts#L32" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:32</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p><h4 id="inherited-from-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#onhold">onHold</a></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/clickables/clickable.ts#L33" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:33</a></p><hr><h3 id="resetdescription" tabindex="-1">resetDescription <a class="header-anchor" href="#resetdescription" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>resetDescription</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<code>string</code>></p><p>Text to display on low conversion amounts, describing what "resetting" is in this context. Defaults to "Reset for ".</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L40" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:40</a></p><hr><h3 id="resettime" tabindex="-1">resetTime <a class="header-anchor" href="#resettime" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>resetTime</strong>: <a href="./../../modules/game/persistence.html#persistent"><code>Persistent</code></a><<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>></p><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-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L58" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:58</a></p><hr><h3 id="shownextat" tabindex="-1">showNextAt <a class="header-anchor" href="#shownextat" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>showNextAt</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not to show how much currency would be required to make the gain amount increase.</p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L42" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:42</a></p><hr><h3 id="small" tabindex="-1">small <a class="header-anchor" href="#small" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>small</strong>: <code>boolean</code></p><h4 id="inherited-from-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#small">small</a></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/clickables/clickable.ts#L31" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:31</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>style</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<a href="./../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>></p><h4 id="inherited-from-5" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-5" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#style">style</a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/clickables/clickable.ts#L22" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:22</a></p><hr><h3 id="tree" tabindex="-1">tree <a class="header-anchor" href="#tree" aria-hidden="true">#</a></h3><p>\u2022 <strong>tree</strong>: <a href="./../../modules/features/trees/tree.html#generictree"><code>GenericTree</code></a></p><p>The tree this reset button is apart of</p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L33" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:33</a></p><hr><h3 id="treenode" tabindex="-1">treeNode <a class="header-anchor" href="#treenode" aria-hidden="true">#</a></h3><p>\u2022 <strong>treeNode</strong>: <a href="./../../modules/features/trees/tree.html#generictreenode"><code>GenericTreeNode</code></a></p><p>The specific tree node associated with this reset button</p><h4 id="defined-in-14" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-14" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L35" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:35</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>visibility</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a><<a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><h4 id="inherited-from-6" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-6" aria-hidden="true">#</a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions.html#visibility">visibility</a></p><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/clickables/clickable.ts#L19" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:19</a></p>',118),n=[o];function c(s,l,d,h,f,p){return t(),a("div",null,n)}var m=e(i,[["render",c]]);export{b as __pageData,m as default};
|