2 lines
12 KiB
JavaScript
2 lines
12 KiB
JavaScript
|
import{_ as a,c as t,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: ActionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/clickables/action/interfaces/ActionOptions.md","filePath":"api/features/clickables/action/interfaces/ActionOptions.md","lastUpdated":null}'),i={name:"api/features/clickables/action/interfaces/ActionOptions.md"};function n(c,e,l,s,d,h){return o(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/clickables/action</a> / ActionOptions</p><h1 id="interface-actionoptions" tabindex="-1">Interface: ActionOptions <a class="header-anchor" href="#interface-actionoptions" aria-label="Permalink to "Interface: ActionOptions""></a></h1><p>An object that configures an <a href="./Action">Action</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a><<a href="./../../clickable/interfaces/ClickableOptions"><code>ClickableOptions</code></a>, <code>"onClick"</code> | <code>"onHold"</code>></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><blockquote><p><code>optional</code> <strong>autoStart</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L25" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:25</a></p><hr><h3 id="baroptions" tabindex="-1">barOptions? <a class="header-anchor" href="#baroptions" aria-label="Permalink to "barOptions?""></a></h3><blockquote><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/interfaces/BarOptions"><code>BarOptions</code></a>></p></blockquote><p>A pass-through to the <a href="./../../../bars/bar/interfaces/Bar">Bar</a> 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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L29" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:29</a></p><hr><h3 id="canclick" tabindex="-1">canClick? <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick?""></a></h3><blockquote><p><code>optional</code> <strong>canClick</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><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><code>Omit.canClick</code></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 hr
|