profectus-docs/assets/api_interfaces_features_repeatable.RepeatableOptions.md.21bb1111.js

1 line
8.5 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: RepeatableOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/repeatable.RepeatableOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/repeatable.RepeatableOptions.md"},i=r('<h1 id="interface-repeatableoptions" tabindex="-1">Interface: RepeatableOptions <a class="header-anchor" href="#interface-repeatableoptions" aria-label="Permalink to &quot;Interface: RepeatableOptions&quot;"></a></h1><p><a href="./../../modules/features/repeatable">features/repeatable</a>.RepeatableOptions</p><p>An object that configures a <a href="./../../modules/features/repeatable#repeatable">Repeatable</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;"></a></h2><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="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/features/repeatable.tsx#L62" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:62</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;"></a></h3><p>• <code>Optional</code> <strong>display</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/repeatable#repeatabledisplay"><code>RepeatableDisplay</code></a>&gt;</p><p>The display to use for this repeatable.</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/repeatable.tsx#L72" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:72</a></p><hr><h3 id="initialamount" tabindex="-1">initialAmount <a class="header-anchor" href="#initialamount" aria-label="Permalink to &quot;initialAmount&quot;"></a></h3><p>• <code>Optional</code> <strong>initialAmount</strong>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></p><p>The initial amount this repeatable has on a new save / after reset.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L60" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:60</a></p><hr><h3 id="limit" tabindex="-1">limit <a class="header-anchor" href="#limit" aria-label="Permalink to &quot;limit&quot;"></a></h3><p>• <code>Optional</code> <strong>limit</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt;</p><p>The maximum amount obtainable for this repeatable.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L58" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:58</a></p><hr><h3 id="mark" tabindex="-1">mark <a class="header-anchor" href="#mark" aria-label="Permalink to &quot;mark&quot;"></a></h3><p>• <code>Optional</code> <strong>mark</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code> | <code>boolean</code>&gt;</p><p>Shows a marker on the corner of the feature.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L66" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:66</a></p><hr><h3 id="maximize" tabindex="-1">maximize <a class="header-anchor" href="#maximize" aria-label="Permalink to &quot;maximize&quot;"></a></h3><p>• <code>Optional</code> <strong>maximize</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not clicking this repeatable should attempt to maximize amount based on the requirements met. Requires <a href="./repeatable.RepeatableOptions#requirements">requirements</a> to be a requirement or array of requirements with Requirement.canMaximize true.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L70" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:70</a></p><hr><h3 id="requirements" tabindex="-1">requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to &quot;requirements&quot;"></a></h3><p>• <strong>requirements</strong>: <a href="./../../modules/game/requirements#requirements"><code>Requirements</code></a></p><p>The requirement(s) to increase this repeatable.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L56" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:56</a></p><hr><h3 id="small" tabindex="-1">small <a class="header-anchor" href="#small" aria-label="Permalink to &quot;small&quot;"></a></h3><p>• <code>Optional</code> <strong>small</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Toggles a smaller design for the feature.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L68" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:68</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to &quot;style&quot;"></a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/feature#stylevalue"><code>StyleValue</code></a>&gt;</p><p>CSS to apply to this feature.</p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L64" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:64</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;visibility&quot;"></a></h3><p>• <code>Optional</code> <strong>visibility</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code> | <a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;</p><p>Whether this repeatable should be visible.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/repeatable.tsx#L54" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:54</a></p>',63),s=[i];function l(n,d,c,p,u,h){return t(),a("div",null,s)}const m=e(o,[["render",l]]);export{b as __pageData,m as default};