1 line
12 KiB
JavaScript
1 line
12 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: ActionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/action.ActionOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/action.ActionOptions.md"},i=r('<h1 id="interface-actionoptions" tabindex="-1">Interface: ActionOptions <a class="header-anchor" href="#interface-actionoptions" aria-label="Permalink to "Interface: ActionOptions""></a></h1><p><a href="./../../modules/features/action">features/action</a>.ActionOptions</p><p>An object that configures a <a href="./../../modules/features/action#action">Action</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="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a><<a href="./clickables/clickable.ClickableOptions"><code>ClickableOptions</code></a>, <code>"onClick"</code> | <code>"onHold"</code>></p><p>↳ <strong><code>ActionOptions</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="autostart" tabindex="-1">autoStart <a class="header-anchor" href="#autostart" aria-label="Permalink to "autoStart""></a></h3><p>• <code>Optional</code> <strong>autoStart</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not the action should perform automatically when the cooldown is finished.</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#L45" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:45</a></p><hr><h3 id="baroptions" tabindex="-1">barOptions <a class="header-anchor" href="#baroptions" aria-label="Permalink to "barOptions""></a></h3><p>• <code>Optional</code> <strong>barOptions</strong>: <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a><<a href="./bars/bar.BarOptions"><code>BarOptions</code></a>></p><p>A pass-through to the Bar used to display the cooldown progress for the action.</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#L49" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:49</a></p><hr><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 the clickable may be clicked.</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>Omit.canClick</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/clickables/clickable.ts#L32" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:32</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-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p>Omit.classes</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/clickables/clickable.ts#L34" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:34</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> | { <code>description</code>: <a href="./../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> }></p><p>The display to use for this clickable.</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>Omit.display</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#L40" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:40</a></p><hr><h3 id="duration" tabindex="-1">duration <a class="header-anchor" href="#duration" aria-label="Permalink to "duration""></a></h3><p>• <strong>duration</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a><<a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The cooldown during which the action cannot be performed again, in seconds.</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#L43" target="_blank" rel="noreferrer">profectus/src/features/action.tsx:43</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-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-label="Permalink to "Inherited from""></a></h4><p>Omit.mark</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#L38" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:38</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>amount</code>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</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>amount</code>): <code>void</code></p><p>A function that is called when the action 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>amount</code></td><td style="text-align:left;"><a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</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="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#L47" target="_blank" rel="noreferrer">profectus/src/features/action.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>Omit.small</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/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>Omit.style</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/features/clickables/clickable.ts#L36" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:36</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>Omit.visibility</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/features/clickables/clickable.ts#L30" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.ts:30</a></p>',91),c=[i];function n(l,s,d,h,f,u){return t(),a("div",null,c)}const m=e(o,[["render",n]]);export{b as __pageData,m as default};
|