1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
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 "Interface: BaseChallenge""></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 "Properties""></a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to "[Component]""></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 "Defined in""></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 "[GatherProps]""></a></h3><p>• <strong>[GatherProps]</strong>: () => <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>unknown</code>></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="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>></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 "Returns""></a></h5><p><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>unknown</code>></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#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 "active""></a></h3><p>• <strong>active</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a><<code>boolean</code>></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 "Defined in""></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-anchor" href="#cancomplete" aria-label="Permalink to "canComplete""></a></h3><p>• <strong>canComplete</strong>: <code>Ref</code><<a href="./../../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The current amount of times this challenge can be completed.</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#L95" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:95</a></p><hr><h3 id="complete" tabindex="-1">complete <a class="header-anchor" href="#complete" aria-label="Permalink to "complete""></a></h3><p>• <strong>complete</strong>: (<code>remainInChallenge?</code>: <code>boolean</code>) => <code>void</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>remainInChallenge?</code>): <code>void</code></p><p>A function to complete this challenge.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>remainInChallenge?</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;">Optional parameter to specify if the challenge should remain active after completion.</td></tr></tbody></table><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></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#L110" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:110</a></p><hr><h3 id="completed" tabindex="-1">completed <a class="header-anchor" href="#completed" aria-label="Permalink to "completed""></a></h3><p>• <strong>completed</strong>: <code>Ref</code><<code>boolean</code>></p><p>Whether or not this challenge has been completed.</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#L99" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:99</a></p><hr><h3 id="completions" tabindex="-1">completions <a class="header-anchor" href="#completions" aria-label="Permalink to "completions""></a></h3><p>• <strong>completions</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a><<a href="./../../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>The current number of times this challenge has been 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#L97" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:97</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</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#L93" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:93</a></p><hr><h3 id="maxed" tabindex="-1">maxed <a class="header-anchor" href="#maxed" aria-label="Permalink to "maxed""></a></h3><p>• <strong>maxed</strong>: <code>Ref</code><<code>boolean</code>></p><p>Whether or not this challenge's completion count is at its limit.</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#L101" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:101</a></p><hr><h3 id="toggle" tabindex="-1">toggle <a class="header-anchor" href="#toggle" aria-label="Permalink to "toggle""></a></h3><p>• <strong>toggle</strong>: <code>VoidFunction</code></p><p>A function to enter or leave the 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#L105" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:105</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/challenges/challenge#challengetype"><code>ChallengeType</code></a></p><p>A symbol that helps identify features of the same type.</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#L112" target="_blank" rel="noreferrer">profectus/src/features/challenges/challenge.tsx:112</a></p>',79),l=[o];function c(s,i,h,d,p,f){return t(),a("div",null,l)}const b=e(n,[["render",c]]);export{u as __pageData,b as default};
|