1 line
17 KiB
JavaScript
1 line
17 KiB
JavaScript
import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Interface: ResetButtonOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/data/common.ResetButtonOptions.md","lastUpdated":null}'),o={name:"api/interfaces/data/common.ResetButtonOptions.md"},i=r('<h1 id="interface-resetbuttonoptions" tabindex="-1">Interface: ResetButtonOptions <a class="header-anchor" href="#interface-resetbuttonoptions" aria-label="Permalink to "Interface: ResetButtonOptions""></a></h1><p><a href="./../../modules/data/common">data/common</a>.ResetButtonOptions</p><p>An object that configures a <a href="./../../modules/data/common#resetbutton">ResetButton</a></p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-label="Permalink to "Hierarchy""></a></h2><ul><li><p><a href="../features/clickables/clickable.ClickableOptions"><code>ClickableOptions</code></a></p><p>↳ <strong><code>ResetButtonOptions</code></strong></p></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><p>• <code>Optional</code> <strong>canClick</strong>: <a href="./../../modules/util/computed#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#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.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#canclick">canClick</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L57" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:57</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to "classes""></a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</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><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.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#classes">classes</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L34" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:34</a></p><hr><h3 id="conversion" tabindex="-1">conversion <a class="header-anchor" href="#conversion" aria-label="Permalink to "conversion""></a></h3><p>• <strong>conversion</strong>: <a href="./../../modules/features/conversion#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L36" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:36</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to "display""></a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/features/feature#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-label="Permalink to "Overrides""></a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#display">display</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L52" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:52</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to "mark""></a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>string</code> | <code>boolean</code>></p><p>Shows a marker on the corner of the 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="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#mark">mark</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L38" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:38</a></p><hr><h3 id="minimumgain" tabindex="-1">minimumGain <a class="header-anchor" href="#minimumgain" aria-label="Permalink to "minimumGain""></a></h3><p>• <code>Optional</code> <strong>minimumGain</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>When <a href="./common.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-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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L61" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:61</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick""></a></h3><p>• <code>Optional</code> <strong>onClick</strong>: (<code>e?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) => <code>void</code></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>▸ (<code>e?</code>): <code>void</code></p><p>A function that is called when the clickable is clicked.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></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;"><a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></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-label="Permalink to "Inherited from""></a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#onclick">onClick</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L52" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:52</a></p><hr><h3 id="onhold" tabindex="-1">onHold <a class="header-anchor" href="#onhold" aria-label="Permalink to "onHold""></a></h3><p>• <code>Optional</code> <strong>onHold</strong>: <code>VoidFunction</code></p><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="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#onhold">onHold</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:54</a></p><hr><h3 id="resetdescription" tabindex="-1">resetDescription <a class="header-anchor" href="#resetdescription" aria-label="Permalink to "resetDescription""></a></h3><p>• <code>Optional</code> <strong>resetDescription</strong>: <a href="./../../modules/util/computed#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L45" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:45</a></p><hr><h3 id="resettime" tabindex="-1">resetTime <a class="header-anchor" href="#resettime" aria-label="Permalink to "resetTime""></a></h3><p>• <code>Optional</code> <strong>resetTime</strong>: <a href="./../../modules/game/persistence#persistent"><code>Persistent</code></a><<a href="./../../modules/lib/break_eternity#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L63" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:63</a></p><hr><h3 id="shownextat" tabindex="-1">showNextAt <a class="header-anchor" href="#shownextat" aria-label="Permalink to "showNextAt""></a></h3><p>• <code>Optional</code> <strong>showNextAt</strong>: <a href="./../../modules/util/computed#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L47" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:47</a></p><hr><h3 id="small" tabindex="-1">small <a class="header-anchor" href="#small" aria-label="Permalink to "small""></a></h3><p>• <code>Optional</code> <strong>small</strong>: <code>boolean</code></p><p>Toggles a smaller design for the 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="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#small">small</a></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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L50" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:50</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to "style""></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/features/feature#stylevalue"><code>StyleValue</code></a>></p><p>CSS to apply to this feature.</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="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#style">style</a></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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:36</a></p><hr><h3 id="tree" tabindex="-1">tree <a class="header-anchor" href="#tree" aria-label="Permalink to "tree""></a></h3><p>• <strong>tree</strong>: <a href="./../../modules/features/trees/tree#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L38" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:38</a></p><hr><h3 id="treenode" tabindex="-1">treeNode <a class="header-anchor" href="#treenode" aria-label="Permalink to "treeNode""></a></h3><p>• <strong>treeNode</strong>: <a href="./../../modules/features/trees/tree#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-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L40" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:40</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code> | <a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>></p><p>Whether this clickable should be visible.</p><h4 id="inherited-from-6" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-6" aria-label="Permalink to "Inherited from""></a></h4><p><a href="../features/clickables/clickable.ClickableOptions">ClickableOptions</a>.<a href="./../features/clickables/clickable.ClickableOptions#visibility">visibility</a></p><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/clickables/clickable.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:30</a></p>',125),n=[i];function c(l,s,d,h,f,u){return t(),a("div",null,n)}const m=e(o,[["render",c]]);export{p as __pageData,m as default};
|