1 line
18 KiB
JavaScript
1 line
18 KiB
JavaScript
import{_ as a,c as r,a0 as t,o}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: Action","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/clickables/action/interfaces/Action.md","filePath":"api/features/clickables/action/interfaces/Action.md","lastUpdated":null}'),i={name:"api/features/clickables/action/interfaces/Action.md"};function n(c,e,s,l,d,h){return o(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/clickables/action</a> / Action</p><h1 id="interface-action" tabindex="-1">Interface: Action <a class="header-anchor" href="#interface-action" aria-label="Permalink to "Interface: Action""></a></h1><p>An object that represents a feature that can be clicked upon, and then has a cooldown before it can be clicked again.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="vuefeature" tabindex="-1">[VueFeature] <a class="header-anchor" href="#vuefeature" aria-label="Permalink to "\\[VueFeature\\]""></a></h3><blockquote><p><strong>[VueFeature]</strong>: <code>true</code></p></blockquote><p>Used to identify Vue Features</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#[vuefeature]"><code>[VueFeature]</code></a></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/util/vue.tsx#L43" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:43</a></p><hr><h3 id="autostart" tabindex="-1">autoStart <a class="header-anchor" href="#autostart" aria-label="Permalink to "autoStart""></a></h3><blockquote><p><strong>autoStart</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</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-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#L37" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:37</a></p><hr><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-label="Permalink to "canClick""></a></h3><blockquote><p><strong>canClick</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code>></p></blockquote><p>Whether or not the action may be performed.</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/action.tsx#L39" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:39</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#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#classes"><code>classes</code></a></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#L35" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:35</a></p><hr><h3 id="components" tabindex="-1">components <a class="header-anchor" href="#components" aria-label="Permalink to "components""></a></h3><blockquote><p><strong>components</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 components to render inside the vue feature</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#components"><code>components</code></a></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/util/vue.tsx#L39" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:39</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>></p></blockquote><p>The display to use for this action.</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#L41" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:41</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#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</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-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#L35" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:35</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><blockquote><p><strong>id</strong>: <code>string</code></p></blockquote><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#id"><code>id</code></a></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#L31" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:31</a></p><hr><h3 id="isholding" tabindex="-1">isHolding <a class="header-anchor" href="#isholding" aria-label="Permalink to "isHolding""></a></h3><blockquote><p><strong>isHolding</strong>: <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a><<code>boolean</code>, <code>boolean</code>></p></blockquote><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-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/features/clickables/action.tsx#L45" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:45</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-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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L43" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:43</a></p><hr><h3 id="progress" tabindex="-1">progress <a class="header-anchor" href="#progress" aria-label="Permalink to "progress""></a></h3><blockquote><p><strong>progress</strong>: <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a><<a href="./../../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>, <a href="./../../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>The current amount of progress through the cooldown.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/clickables/action.tsx#L47" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:47</a></p><hr><h3 id="progressbar" tabindex="-1">progressBar <a class="header-anchor" href="#progressbar" aria-label="Permalink to "progressBar""></a></h3><blockquote><p><strong>progressBar</strong>: <a href="./../../../bars/bar/interfaces/Bar"><code>Bar</code></a></p></blockquote><p>The bar used to display the current cooldown progress.</p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" 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#L49" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:49</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#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</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-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#style"><code>style</code></a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L37" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:37</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><blockquote><p><strong>type</strong>: <em>typeof</em> <a href="./../variables/ActionType"><code>ActionType</code></a></p></blockquote><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" 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#L53" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:53</a></p><hr><h3 id="update" tabindex="-1">update() <a class="header-anchor" href="#update" aria-label="Permalink to "update()""></a></h3><blockquote><p><strong>update</strong>: (<code>diff</code>) => <code>void</code></p></blockquote><p>Update the cooldown the specified number of seconds</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><h5 id="diff" tabindex="-1">diff <a class="header-anchor" href="#diff" aria-label="Permalink to "diff""></a></h5><p><code>number</code></p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></p><h4 id="defined-in-14" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-14" 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#L51" target="_blank" rel="noreferrer">profectus/src/features/clickables/action.tsx:51</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#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#visibility"><code>visibility</code></a></p><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L33" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:33</a></p><hr><h3 id="wrappers" tabindex="-1">wrappers <a class="header-anchor" href="#wrappers" aria-label="Permalink to "wrappers""></a></h3><blockquote><p><strong>wrappers</strong>: <a href="./../../../../util/vue/type-aliases/Wrapper"><code>Wrapper</code></a>[]</p></blockquote><p>The components to render wrapped around the vue feature</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><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#wrappers"><code>wrappers</code></a></p><h4 id="defined-in-16" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-16" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L41" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:41</a></p>',131)]))}const p=a(i,[["render",n]]);export{f as __pageData,p as default};
|