1 line
11 KiB
JavaScript
1 line
11 KiB
JavaScript
import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Interface: ChallengeOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/challenges/challenge.ChallengeOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/challenges/challenge.ChallengeOptions.md"},n=r('<h1 id="interface-challengeoptions" tabindex="-1">Interface: ChallengeOptions <a class="header-anchor" href="#interface-challengeoptions" aria-label="Permalink to "Interface: ChallengeOptions""></a></h1><p><a href="./../../../modules/features/challenges/challenge">features/challenges/challenge</a>.ChallengeOptions</p><p>An object that configures a <a href="./../../../modules/features/challenges/challenge#challenge">Challenge</a>.</p><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><p>• <code>Optional</code> <strong>canStart</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code>></p><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/challenges/challenge.tsx#L49" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:49</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="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/challenges/challenge.tsx#L61" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:61</a></p><hr><h3 id="completionlimit" tabindex="-1">completionLimit <a class="header-anchor" href="#completionlimit" aria-label="Permalink to "completionLimit""></a></h3><p>• <code>Optional</code> <strong>completionLimit</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 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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/challenges/challenge.tsx#L57" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:57</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>effectDisplay?</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>goal?</code>: <a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>reward?</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 challenge.</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/challenges/challenge.tsx#L65" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:65</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="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/challenges/challenge.tsx#L59" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:59</a></p><hr><h3 id="maximize" tabindex="-1">maximize <a class="header-anchor" href="#maximize" aria-label="Permalink to "maximize""></a></h3><p>• <code>Optional</code> <strong>maximize</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a><<code>boolean</code>></p><p>Whether or not completing this challenge should grant multiple completions if requirements met. Requires <a href="./challenge.ChallengeOptions#requirements">requirements</a> to be a requirement or array of requirements with Requirement.canMaximize true.</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/challenges/challenge.tsx#L55" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:55</a></p><hr><h3 id="oncomplete" tabindex="-1">onComplete <a class="header-anchor" href="#oncomplete" aria-label="Permalink to "onComplete""></a></h3><p>• <code>Optional</code> <strong>onComplete</strong>: <code>VoidFunction</code></p><p>A function that is called when the challenge is completed.</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/challenges/challenge.tsx#L81" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:81</a></p><hr><h3 id="onenter" tabindex="-1">onEnter <a class="header-anchor" href="#onenter" aria-label="Permalink to "onEnter""></a></h3><p>• <code>Optional</code> <strong>onEnter</strong>: <code>VoidFunction</code></p><p>A function that is called when the challenge is entered.</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/challenges/challenge.tsx#L85" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:85</a></p><hr><h3 id="onexit" tabindex="-1">onExit <a class="header-anchor" href="#onexit" aria-label="Permalink to "onExit""></a></h3><p>• <code>Optional</code> <strong>onExit</strong>: <code>VoidFunction</code></p><p>A function that is called when the challenge is exited.</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/challenges/challenge.tsx#L83" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:83</a></p><hr><h3 id="requirements" tabindex="-1">requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to "requirements""></a></h3><p>• <strong>requirements</strong>: <a href="./../../../modules/game/requirements#requirements"><code>Requirements</code></a></p><p>The requirement(s) to complete this challenge.</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/challenges/challenge.tsx#L53" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:53</a></p><hr><h3 id="reset" tabindex="-1">reset <a class="header-anchor" href="#reset" aria-label="Permalink to "reset""></a></h3><p>• <code>Optional</code> <strong>reset</strong>: <a href="./../../../modules/features/reset#genericreset"><code>GenericReset</code></a></p><p>The reset function for this challenge.</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/challenges/challenge.tsx#L51" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:51</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="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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/challenges/challenge.tsx#L63" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:63</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 challenge should be visible.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/challenges/challenge.tsx#L47" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:47</a></p>',81),l=[n];function c(i,s,h,d,f,u){return t(),a("div",null,l)}const m=e(o,[["render",c]]);export{g as __pageData,m as default};
|