profectus-docs/assets/api_interfaces_features_challenges_challenge.ChallengeOptions.md.3697b2d0.js

2 lines
11 KiB
JavaScript
Raw Normal View History

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 &quot;Interface: ChallengeOptions&quot;"></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 &quot;Properties&quot;"></a></h2><h3 id="canstart" tabindex="-1">canStart <a class="header-anchor" href="#canstart" aria-label="Permalink to &quot;canStart&quot;"></a></h3><p> <code>Optional</code> <strong>canStart</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</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 &quot;Defined in&quot;"></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 &quot;classes&quot;"></a></h3><p> <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</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 &quot;Defined in&quot;"></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 &quot;completionLimit&quot;"></a></h3><p> <code>Optional</code> <strong>completionLimit</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt;</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 &quot;Defined in&quot;"></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 &quot;display&quot;"></a></h3><p> <code>Optional</code> <strong>display</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<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>go