1 line
12 KiB
JavaScript
1 line
12 KiB
JavaScript
import{_ as t,c as a,a0 as r,o as i}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: AchievementOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/achievements/achievement/interfaces/AchievementOptions.md","filePath":"api/features/achievements/achievement/interfaces/AchievementOptions.md","lastUpdated":null}'),o={name:"api/features/achievements/achievement/interfaces/AchievementOptions.md"};function n(s,e,c,l,d,h){return i(),a("div",null,e[0]||(e[0]=[r('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/achievements/achievement</a> / AchievementOptions</p><h1 id="interface-achievementoptions" tabindex="-1">Interface: AchievementOptions <a class="header-anchor" href="#interface-achievementoptions" aria-label="Permalink to "Interface: AchievementOptions""></a></h1><p>An object that configures an <a href="./Achievement">Achievement</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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>>></p></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="display" tabindex="-1">display? <a class="header-anchor" href="#display" aria-label="Permalink to "display?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>> | { <code>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>optionsDisplay</code>: MaybeGetter<Renderable> | undefined; <code>requirement</code>: MaybeGetter<Renderable> | undefined; }</p></blockquote><p>The display to use for this achievement.</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="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p><p>{ <code>effectDisplay</code>: MaybeGetter<Renderable> | undefined; <code>optionsDisplay</code>: MaybeGetter<Renderable> | undefined; <code>requirement</code>: MaybeGetter<Renderable> | undefined; }</p><h4 id="effectdisplay" tabindex="-1">effectDisplay? <a class="header-anchor" href="#effectdisplay" aria-label="Permalink to "effectDisplay?""></a></h4><blockquote><p><code>optional</code> <strong>effectDisplay</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>Description of what will change (if anything) for achieving this.</p><h4 id="optionsdisplay" tabindex="-1">optionsDisplay? <a class="header-anchor" href="#optionsdisplay" aria-label="Permalink to "optionsDisplay?""></a></h4><blockquote><p><code>optional</code> <strong>optionsDisplay</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>Any additional things to display on this achievement, such as a toggle for it's effect.</p><h4 id="requirement" tabindex="-1">requirement? <a class="header-anchor" href="#requirement" aria-label="Permalink to "requirement?""></a></h4><blockquote><p><code>optional</code> <strong>requirement</strong>: MaybeGetter<Renderable> | undefined</p></blockquote><p>Description of the requirement(s) for this achievement. If unspecified then the requirements will be displayed automatically based on <a href="./AchievementOptions#requirements">requirements</a>.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L52" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:52</a></p><hr><h3 id="image" tabindex="-1">image? <a class="header-anchor" href="#image" aria-label="Permalink to "image?""></a></h3><blockquote><p><code>optional</code> <strong>image</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>An image to display as the background for 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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L65" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:65</a></p><hr><h3 id="oncomplete" tabindex="-1">onComplete? <a class="header-anchor" href="#oncomplete" aria-label="Permalink to "onComplete?""></a></h3><blockquote><p><code>optional</code> <strong>onComplete</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called when the achievement is 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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L69" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:69</a></p><hr><h3 id="requirements" tabindex="-1">requirements? <a class="header-anchor" href="#requirements" aria-label="Permalink to "requirements?""></a></h3><blockquote><p><code>optional</code> <strong>requirements</strong>: <a href="./../../../../game/requirements/type-aliases/Requirements"><code>Requirements</code></a></p></blockquote><p>The requirement(s) to earn this achievement. Can be left null if using <a href="./Achievement#complete">Achievement.complete</a>.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L50" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:50</a></p><hr><h3 id="showpopups" tabindex="-1">showPopups? <a class="header-anchor" href="#showpopups" aria-label="Permalink to "showPopups?""></a></h3><blockquote><p><code>optional</code> <strong>showPopups</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><p>Whether or not to display a notification popup when this achievement is earned.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L67" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:67</a></p><hr><h3 id="small" tabindex="-1">small? <a class="header-anchor" href="#small" aria-label="Permalink to "small?""></a></h3><blockquote><p><code>optional</code> <strong>small</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><p>Toggles a smaller design for the feature.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/achievements/achievement.tsx#L63" target="_blank" rel="noreferrer">profectus/src/features/achievements/achievement.tsx:63</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this feature.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#style"><code>style</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#visibility"><code>visibility</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',77)]))}const u=t(o,[["render",n]]);export{f as __pageData,u as default};
|