1 line
7.8 KiB
JavaScript
1 line
7.8 KiB
JavaScript
import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: BaseAction","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/action.BaseAction.md","lastUpdated":null}'),o={name:"api/interfaces/features/action.BaseAction.md"},n=r('<h1 id="interface-baseaction" tabindex="-1">Interface: BaseAction <a class="header-anchor" href="#interface-baseaction" aria-label="Permalink to "Interface: BaseAction""></a></h1><p><a href="./../../modules/features/action">features/action</a>.BaseAction</p><p>The properties that are added onto a processed <a href="./action.ActionOptions">ActionOptions</a> to create an <a href="./../../modules/features/action#action">Action</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/action.tsx#L69" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:69</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/action.tsx#L71" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:71</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-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/action.tsx#L57" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:57</a></p><hr><h3 id="isholding" tabindex="-1">isHolding <a class="header-anchor" href="#isholding" aria-label="Permalink to "isHolding""></a></h3><p>• <strong>isHolding</strong>: <code>Ref</code><<code>boolean</code>></p><p>Whether or not the player is holding down the action. Actions will be considered clicked as soon as the cooldown completes when being held down.</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/action.tsx#L61" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:61</a></p><hr><h3 id="progress" tabindex="-1">progress <a class="header-anchor" href="#progress" aria-label="Permalink to "progress""></a></h3><p>• <strong>progress</strong>: <code>Ref</code><<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The current amount of progress through the cooldown.</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/action.tsx#L63" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:63</a></p><hr><h3 id="progressbar" tabindex="-1">progressBar <a class="header-anchor" href="#progressbar" aria-label="Permalink to "progressBar""></a></h3><p>• <strong>progressBar</strong>: <a href="./../../modules/features/bars/bar#genericbar"><code>GenericBar</code></a></p><p>The bar used to display the current cooldown progress.</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/action.tsx#L65" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:65</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/action#actiontype"><code>ActionType</code></a></p><p>A symbol that helps identify features of the same type.</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/action.tsx#L59" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:59</a></p><hr><h3 id="update" tabindex="-1">update <a class="header-anchor" href="#update" aria-label="Permalink to "update""></a></h3><p>• <strong>update</strong>: (<code>diff</code>: <code>number</code>) => <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>diff</code>): <code>void</code></p><p>Update the cooldown the specified number of seconds</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>diff</code></td><td style="text-align:left;"><code>number</code></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/action.tsx#L67" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:67</a></p>',61),i=[n];function s(d,c,h,l,p,f){return a(),t("div",null,i)}const g=e(o,[["render",s]]);export{b as __pageData,g as default};
|