1 line
12 KiB
JavaScript
1 line
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 href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/clickable.tsx#L24" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:24</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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></blockquote><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><code>Omit.classes</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="display" tabindex="-1">display? <a class="header-anchor" href="#display" aria-label="Permalink to "display?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>> | { <code>description</code>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>>; <code>title</code>: MaybeGetter<Renderable> | undefined; }</p></blockquote><p>The display to use for this clickable.</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="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p><p>{ <code>description</code>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>>; <code>title</code>: MaybeGetter<Renderable> | undefined; }</p><h4 id="description" tabindex="-1">description <a class="header-anchor" href="#description" aria-label="Permalink to "description""></a></h4><blockquote><p><strong>description</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><p>The main text that appears in the display.</p><h4 id="title" tabindex="-1">title? <a class="header-anchor" href="#title" aria-label="Permalink to "title?""></a></h4><blockquote><p><code>optional</code> <strong>title</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A header to appear at the top of the display.</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><code>Omit.display</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/clickable.tsx#L26" target="_blank" rel="noreferrer">profectus/src/features/clickables/clickable.tsx:26</a></p><hr><h3 id="duration" tabindex="-1">duration <a class="header-anchor" href="#duration" aria-label="Permalink to "duration""></a></h3><blockquote><p><strong>duration</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L23" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:23</a></p><hr><h3 id="onclick" tabindex="-1">onClick() <a class="header-anchor" href="#onclick" aria-label="Permalink to "onClick()""></a></h3><blockquote><p><strong>onClick</strong>: (<code>amount</code>) => <code>void</code></p></blockquote><p>A function that is called when the action is clicked.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="amount" tabindex="-1">amount <a class="header-anchor" href="#amount" aria-label="Permalink to "amount""></a></h5><p><a href="./../../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L27" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:27</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this 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><code>Omit.style</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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</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><code>Omit.visibility</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',83)]))}const u=a(i,[["render",n]]);export{f as __pageData,u as default};
|