2 lines
18 KiB
JavaScript
2 lines
18 KiB
JavaScript
|
import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: features/achievements/achievement","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/achievement.md","lastUpdated":null}'),c={name:"api/modules/features/achievement.md"},d=o('<h1 id="module-features-achievements-achievement" tabindex="-1">Module: features/achievements/achievement <a class="header-anchor" href="#module-features-achievements-achievement" aria-label="Permalink to "Module: features/achievements/achievement""></a></h1><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-label="Permalink to "Enumerations""></a></h2><h3 id="achievementdisplay" tabindex="-1">AchievementDisplay <a class="header-anchor" href="#achievementdisplay" aria-label="Permalink to "AchievementDisplay""></a></h3><p>• <strong>AchievementDisplay</strong>: <code>Object</code></p><p>Modes for only displaying some achievements.</p><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>All</code></td><td style="text-align:left;"><code>"all"</code></td></tr><tr><td style="text-align:left;"><code>Configurable</code></td><td style="text-align:left;"><code>"configurable"</code></td></tr><tr><td style="text-align:left;"><code>Incomplete</code></td><td style="text-align:left;"><code>"incomplete"</code></td></tr><tr><td style="text-align:left;"><code>None</code></td><td style="text-align:left;"><code>"none"</code></td></tr></tbody></table><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#L50" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:50</a></p><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to "Interfaces""></a></h2><h3 id="achievementoptions" tabindex="-1">AchievementOptions <a class="header-anchor" href="#achievementoptions" aria-label="Permalink to "AchievementOptions""></a></h3><p>• <strong>AchievementOptions</strong>: <code>Object</code></p><p>An object that configures an <a href="./achievement#achievement">Achievement</a>.</p><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>classes?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<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>boolean</code>>></td><td style="text-align:left;">Dictionary of CSS classes to apply to this feature.</td></tr><tr><td style="text-align:left;"><code>display?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<a href="./feature#coercablecomponent"><code>CoercableComponent</code></a> | { <code>effectDisplay?</code>: <a href="./feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>optionsDisplay?</code>: <a href="./feature#coercablecomponent"><code>CoercableComponent</code></a> ; <code>requirement?</code>: <a href="./feature#coercablecomponent"><code>CoercableComponent</code></a> }></td><td style="text-align:left;">The display to use for this achievement.</td></tr><tr><td style="text-align:left;"><code>image?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<code>string</code>></td><td style="text-align:left;">An image to display as the background for this achievement.</td>
|