profectus-docs/assets/api_interfaces_features_challenges_challenge.BaseChallenge.md.cab2baa7.js

2 lines
10 KiB
JavaScript
Raw Normal View History

import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BaseChallenge","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/challenges/challenge.BaseChallenge.md","lastUpdated":null}'),n={name:"api/interfaces/features/challenges/challenge.BaseChallenge.md"},o=r('<h1 id="interface-basechallenge" tabindex="-1">Interface: BaseChallenge <a class="header-anchor" href="#interface-basechallenge" aria-label="Permalink to &quot;Interface: BaseChallenge&quot;"></a></h1><p><a href="./../../../modules/features/challenges/challenge">features/challenges/challenge</a>.BaseChallenge</p><p>The properties that are added onto a processed <a href="./challenge.ChallengeOptions">ChallengeOptions</a> to create 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="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to &quot;[Component]&quot;"></a></h3><p> <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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#L114" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:114</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to &quot;[GatherProps]&quot;"></a></h3><p> <strong>[GatherProps]</strong>: () =&gt; <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>unknown</code>&gt;</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><p> (): <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>unknown</code>&gt;</p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h5><p><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>unknown</code>&gt;</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#L116" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:116</a></p><hr><h3 id="active" tabindex="-1">active <a class="header-anchor" href="#active" aria-label="Permalink to &quot;active&quot;"></a></h3><p> <strong>active</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not this challenge is currently active.</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#L103" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:103</a></p><hr><h3 id="cancomplete" tabindex="-1">canComplete <a class="header-anch