1 line
5.9 KiB
JavaScript
1 line
5.9 KiB
JavaScript
import{_ as a,c as t,a0 as r,o as i}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: ModifierSectionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/modifiers/interfaces/ModifierSectionOptions.md","filePath":"api/game/modifiers/interfaces/ModifierSectionOptions.md","lastUpdated":null}'),o={name:"api/game/modifiers/interfaces/ModifierSectionOptions.md"};function n(s,e,d,c,l,f){return i(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../">Profectus</a> / <a href="./../">game/modifiers</a> / ModifierSectionOptions</p><h1 id="interface-modifiersectionoptions" tabindex="-1">Interface: ModifierSectionOptions <a class="header-anchor" href="#interface-modifiersectionoptions" aria-label="Permalink to "Interface: ModifierSectionOptions""></a></h1><p>An object that configures a modifier section via <a href="./../functions/createModifierSection">createModifierSection</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="base" tabindex="-1">base? <a class="header-anchor" href="#base" aria-label="Permalink to "base?""></a></h3><blockquote><p><code>optional</code> <strong>base</strong>: <a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p></blockquote><p>The base value that'll be passed into the modifier. Defaults to 1.</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/game/modifiers.tsx#L303" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:303</a></p><hr><h3 id="basetext" tabindex="-1">baseText? <a class="header-anchor" href="#basetext" aria-label="Permalink to "baseText?""></a></h3><blockquote><p><code>optional</code> <strong>baseText</strong>: <a href="./../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><p>The label to use for the base value. Defaults to "Base".</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/game/modifiers.tsx#L307" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:307</a></p><hr><h3 id="modifier" tabindex="-1">modifier <a class="header-anchor" href="#modifier" aria-label="Permalink to "modifier""></a></h3><blockquote><p><strong>modifier</strong>: <a href="./../../../util/common/type-aliases/WithRequired"><code>WithRequired</code></a><<a href="./Modifier"><code>Modifier</code></a>, <code>"description"</code>></p></blockquote><p>The modifier to render.</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/game/modifiers.tsx#L301" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:301</a></p><hr><h3 id="smallerisbetter" tabindex="-1">smallerIsBetter? <a class="header-anchor" href="#smallerisbetter" aria-label="Permalink to "smallerIsBetter?""></a></h3><blockquote><p><code>optional</code> <strong>smallerIsBetter</strong>: <code>boolean</code></p></blockquote><p>Determines if numbers larger or smaller than the base should be displayed as red.</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/game/modifiers.tsx#L309" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:309</a></p><hr><h3 id="subtitle" tabindex="-1">subtitle? <a class="header-anchor" href="#subtitle" aria-label="Permalink to "subtitle?""></a></h3><blockquote><p><code>optional</code> <strong>subtitle</strong>: <code>string</code></p></blockquote><p>Smaller text that appears in the header after the title.</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/game/modifiers.tsx#L299" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:299</a></p><hr><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-label="Permalink to "title""></a></h3><blockquote><p><strong>title</strong>: <code>string</code></p></blockquote><p>The header for the section.</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/game/modifiers.tsx#L297" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:297</a></p><hr><h3 id="unit" tabindex="-1">unit? <a class="header-anchor" href="#unit" aria-label="Permalink to "unit?""></a></h3><blockquote><p><code>optional</code> <strong>unit</strong>: <code>string</code></p></blockquote><p>The unit of the value being modified, if any.</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/game/modifiers.tsx#L305" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:305</a></p>',45)]))}const u=a(o,[["render",n]]);export{p as __pageData,u as default};
|