1 line
6.1 KiB
JavaScript
1 line
6.1 KiB
JavaScript
import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BaseAchievement","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/achievements/achievement.BaseAchievement.md","lastUpdated":null}'),n={name:"api/interfaces/features/achievements/achievement.BaseAchievement.md"},o=r('<h1 id="interface-baseachievement" tabindex="-1">Interface: BaseAchievement <a class="header-anchor" href="#interface-baseachievement" aria-label="Permalink to "Interface: BaseAchievement""></a></h1><p><a href="./../../../modules/features/achievements/achievement">features/achievements/achievement</a>.BaseAchievement</p><p>The properties that are added onto a processed <a href="./achievement.AchievementOptions">AchievementOptions</a> to create an <a href="./../../../modules/features/achievements/achievement#achievement">Achievement</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/8c0a0c4/src/features/achievements/achievement.tsx#L107" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:107</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/8c0a0c4/src/features/achievements/achievement.tsx#L109" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:109</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>VoidFunction</code></p><p>A function to complete this achievement.</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/8c0a0c4/src/features/achievements/achievement.tsx#L103" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:103</a></p><hr><h3 id="earned" tabindex="-1">earned <a class="header-anchor" href="#earned" aria-label="Permalink to "earned""></a></h3><p>• <strong>earned</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a><<code>boolean</code>></p><p>Whether or not this achievement has been earned.</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/8c0a0c4/src/features/achievements/achievement.tsx#L101" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:101</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-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/8c0a0c4/src/features/achievements/achievement.tsx#L99" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:99</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/achievements/achievement#achievementtype"><code>AchievementType</code></a></p><p>A symbol that helps identify features of the same type.</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/8c0a0c4/src/features/achievements/achievement.tsx#L105" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:105</a></p>',43),i=[o];function s(c,h,d,p,l,f){return a(),t("div",null,i)}const b=e(n,[["render",s]]);export{u as __pageData,b as default};
|