profectus-docs/assets/api_modules_features_achievements_achievement.md.c1fa5c48.js

1 line
7.6 KiB
JavaScript

import{_ as e,c as t,o as a,a as c}from"./app.ab34650d.js";const p=JSON.parse('{"title":"Module: features/achievements/achievement","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Components","slug":"components"},{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"Achievement","slug":"achievement"},{"level":3,"title":"GenericAchievement","slug":"genericachievement"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"AchievementType","slug":"achievementtype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createAchievement","slug":"createachievement"}],"relativePath":"api/modules/features/achievements/achievement.md","lastUpdated":null}'),i={name:"api/modules/features/achievements/achievement.md"},n=c('<h1 id="module-features-achievements-achievement" tabindex="-1">Module: features/achievements/achievement <a class="header-anchor" href="#module-features-achievements-achievement" aria-hidden="true">#</a></h1><h2 id="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-hidden="true">#</a></h2><ul><li><a href="./AchievementComponent.html">Achievement</a></li></ul><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../../interfaces/features/achievements/achievement.AchievementOptions">AchievementOptions</a></li><li><a href="../../../interfaces/features/achievements/achievement.BaseAchievement">BaseAchievement</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="achievement" tabindex="-1">Achievement <a class="header-anchor" href="#achievement" aria-hidden="true">#</a></h3><p>\u01AC <strong>Achievement</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/achievements/achievement.BaseAchievement"><code>BaseAchievement</code></a>, { <code>classes</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>display</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>image</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;image&quot;</code>]&gt; ; <code>mark</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;mark&quot;</code>]&gt; ; <code>style</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/achievements/achievement.AchievementOptions"><code>AchievementOptions</code></a></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/achievements/achievement.tsx#L54" target="_blank" rel="noopener noreferrer">profectus/src/features/achievements/achievement.tsx:54</a></p><hr><h3 id="genericachievement" tabindex="-1">GenericAchievement <a class="header-anchor" href="#genericachievement" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericAchievement</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./achievement.html#achievement"><code>Achievement</code></a>&lt;<a href="../../../interfaces/features/achievements/achievement.AchievementOptions"><code>AchievementOptions</code></a>&gt;, { <code>visibility</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&gt;</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/achievements/achievement.tsx#L66" target="_blank" rel="noopener noreferrer">profectus/src/features/achievements/achievement.tsx:66</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="achievementtype" tabindex="-1">AchievementType <a class="header-anchor" href="#achievementtype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>AchievementType</strong>: typeof <a href="./achievement.html#achievementtype"><code>AchievementType</code></a></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/achievements/achievement.tsx#L32" target="_blank" rel="noopener noreferrer">profectus/src/features/achievements/achievement.tsx:32</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createachievement" tabindex="-1">createAchievement <a class="header-anchor" href="#createachievement" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createAchievement</strong>&lt;<code>T</code>&gt;(<code>optionsFunc?</code>): <a href="./achievement.html#achievement"><code>Achievement</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/achievements/achievement.AchievementOptions"><code>AchievementOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>optionsFunc?</code></td><td style="text-align:left;"><a href="./../feature.html#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../../interfaces/features/achievements/achievement.BaseAchievement"><code>BaseAchievement</code></a>, <a href="./achievement.html#genericachievement"><code>GenericAchievement</code></a>&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./achievement.html#achievement"><code>Achievement</code></a>&lt;<code>T</code>&gt;</p>',31),r=[n];function h(d,o,s,l,m,u){return a(),t("div",null,r)}var v=e(i,[["render",h]]);export{p as __pageData,v as default};