1 line
14 KiB
JavaScript
1 line
14 KiB
JavaScript
import{_ as a,c as t,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: ChallengeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/challenges/challenge/interfaces/ChallengeOptions.md","filePath":"api/features/challenges/challenge/interfaces/ChallengeOptions.md","lastUpdated":null}'),n={name:"api/features/challenges/challenge/interfaces/ChallengeOptions.md"};function l(i,e,c,s,d,h){return o(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/challenges/challenge</a> / ChallengeOptions</p><h1 id="interface-challengeoptions" tabindex="-1">Interface: ChallengeOptions <a class="header-anchor" href="#interface-challengeoptions" aria-label="Permalink to "Interface: ChallengeOptions""></a></h1><p>An object that configures a <a href="./Challenge">Challenge</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="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</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="canstart" tabindex="-1">canStart? <a class="header-anchor" href="#canstart" aria-label="Permalink to "canStart?""></a></h3><blockquote><p><code>optional</code> <strong>canStart</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 this challenge can be started.</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/challenges/challenge.tsx#L33" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:33</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" 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/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></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/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="completionlimit" tabindex="-1">completionLimit? <a class="header-anchor" href="#completionlimit" aria-label="Permalink to "completionLimit?""></a></h3><blockquote><p><code>optional</code> <strong>completionLimit</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 maximum number of times the challenge can be completed.</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/challenges/challenge.tsx#L39" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.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>> | { <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>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>goal</code>: MaybeGetter<Renderable> | undefined; <code>reward</code>: MaybeGetter<Renderable> | undefined; <code>title</code>: MaybeGetter<Renderable> | undefined; }</p></blockquote><p>The display to use for this challenge.</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>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>goal</code>: MaybeGetter<Renderable> | undefined; <code>reward</code>: MaybeGetter<Renderable> | undefined; <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="effectdisplay" tabindex="-1">effectDisplay? <a class="header-anchor" href="#effectdisplay" aria-label="Permalink to "effectDisplay?""></a></h4><blockquote><p><code>optional</code> <strong>effectDisplay</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A description of the current effect of this challenge.</p><h4 id="goal" tabindex="-1">goal? <a class="header-anchor" href="#goal" aria-label="Permalink to "goal?""></a></h4><blockquote><p><code>optional</code> <strong>goal</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A description of the current goal for this challenge. If unspecified then the requirements will be displayed automatically based on <a href="./ChallengeOptions#requirements">requirements</a>.</p><h4 id="reward" tabindex="-1">reward? <a class="header-anchor" href="#reward" aria-label="Permalink to "reward?""></a></h4><blockquote><p><code>optional</code> <strong>reward</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>A description of what will change upon completing this challenge.</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="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/features/challenges/challenge.tsx#L41" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:41</a></p><hr><h3 id="oncomplete" tabindex="-1">onComplete? <a class="header-anchor" href="#oncomplete" aria-label="Permalink to "onComplete?""></a></h3><blockquote><p><code>optional</code> <strong>onComplete</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the challenge is completed.</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/challenges/challenge.tsx#L56" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:56</a></p><hr><h3 id="onenter" tabindex="-1">onEnter? <a class="header-anchor" href="#onenter" aria-label="Permalink to "onEnter?""></a></h3><blockquote><p><code>optional</code> <strong>onEnter</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the challenge is entered.</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/challenges/challenge.tsx#L60" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:60</a></p><hr><h3 id="onexit" tabindex="-1">onExit? <a class="header-anchor" href="#onexit" aria-label="Permalink to "onExit?""></a></h3><blockquote><p><code>optional</code> <strong>onExit</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the challenge is exited.</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/challenges/challenge.tsx#L58" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:58</a></p><hr><h3 id="requirements" tabindex="-1">requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to "requirements""></a></h3><blockquote><p><strong>requirements</strong>: <a href="./../../../../game/requirements/type-aliases/Requirements"><code>Requirements</code></a></p></blockquote><p>The requirement(s) to complete this challenge.</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/features/challenges/challenge.tsx#L37" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:37</a></p><hr><h3 id="reset" tabindex="-1">reset? <a class="header-anchor" href="#reset" aria-label="Permalink to "reset?""></a></h3><blockquote><p><code>optional</code> <strong>reset</strong>: <a href="./../../../reset/interfaces/Reset"><code>Reset</code></a></p></blockquote><p>The reset function for this challenge.</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/challenges/challenge.tsx#L35" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:35</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-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/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#style"><code>style</code></a></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/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-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/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#visibility"><code>visibility</code></a></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/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',95)]))}const f=a(n,[["render",l]]);export{p as __pageData,f as default};
|