profectus-docs/assets/api_interfaces_data_common.ResetButtonOptions.md.7fcf71d7.js

2 lines
17 KiB
JavaScript
Raw Normal View History

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 &quot;Interface: ResetButtonOptions&quot;"></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 &quot;Hierarchy&quot;"></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 &quot;Properties&quot;"></a></h2><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to &quot;canClick&quot;"></a></h3><p> <code>Optional</code> <strong>canClick</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</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 &quot;Overrides&quot;"></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 &quot;Defined in&quot;"></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 &quot;classes&quot;"></a></h3><p> <code>Optional</code> <strong>classes</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</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 &quot;Inherited from&quot;"></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 &quot;Defined in&quot;"></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 &quot;conversion&quot;"></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 &quot