1 line
9.3 KiB
JavaScript
1 line
9.3 KiB
JavaScript
import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseRepeatable","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/repeatable.BaseRepeatable.md","lastUpdated":null}'),o={name:"api/interfaces/features/repeatable.BaseRepeatable.md"},n=r('<h1 id="interface-baserepeatable" tabindex="-1">Interface: BaseRepeatable <a class="header-anchor" href="#interface-baserepeatable" aria-label="Permalink to "Interface: BaseRepeatable""></a></h1><p><a href="./../../modules/features/repeatable">features/repeatable</a>.BaseRepeatable</p><p>The properties that are added onto a processed <a href="./repeatable.RepeatableOptions">RepeatableOptions</a> to create 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 "Properties""></a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to "[Component]""></a></h3><p>• <strong>[Component]</strong>: <a href="./../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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/features/repeatable.tsx#L97" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:97</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to "[GatherProps]""></a></h3><p>• <strong>[GatherProps]</strong>: () => <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>unknown</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>▸ (): <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>unknown</code>></p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><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>unknown</code>></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/repeatable.tsx#L99" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:99</a></p><hr><h3 id="amount" tabindex="-1">amount <a class="header-anchor" href="#amount" aria-label="Permalink to "amount""></a></h3><p>• <strong>amount</strong>: <a href="./../../modules/game/persistence#persistent"><code>Persistent</code></a><<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The current amount this repeatable has.</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/features/repeatable.tsx#L82" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:82</a></p><hr><h3 id="amounttoincrease" tabindex="-1">amountToIncrease <a class="header-anchor" href="#amounttoincrease" aria-label="Permalink to "amountToIncrease""></a></h3><p>• <strong>amountToIncrease</strong>: <code>Ref</code><<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>How much amount can be increased by, or 1 if unclickable. Capped at 1 if <a href="./repeatable.RepeatableOptions#maximize">maximize</a> is false.</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/features/repeatable.tsx#L91" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:91</a></p><hr><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick""></a></h3><p>• <strong>canClick</strong>: <a href="./../../modules/util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>></p><p>Whether or not this repeatable can be clicked.</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/repeatable.tsx#L86" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:86</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</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/features/repeatable.tsx#L80" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:80</a></p><hr><h3 id="maxed" tabindex="-1">maxed <a class="header-anchor" href="#maxed" aria-label="Permalink to "maxed""></a></h3><p>• <strong>maxed</strong>: <code>Ref</code><<code>boolean</code>></p><p>Whether or not this repeatable's amount is at it's limit.</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/repeatable.tsx#L84" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:84</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick""></a></h3><p>• <strong>onClick</strong>: (<code>event?</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-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>event?</code>): <code>void</code></p><p>A function that gets called when this repeatable 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>event?</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-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></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/repeatable.tsx#L93" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:93</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><p>• <strong>type</strong>: typeof <a href="./../../modules/features/repeatable#repeatabletype"><code>RepeatableType</code></a></p><p>A symbol that helps identify features of the same type.</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/features/repeatable.tsx#L95" target="_blank" rel="noreferrer">profectus/src/features/repeatable.tsx:95</a></p>',67),i=[n];function s(l,d,c,p,h,f){return t(),a("div",null,i)}const m=e(o,[["render",s]]);export{b as __pageData,m as default};
|