1 line
6.9 KiB
JavaScript
1 line
6.9 KiB
JavaScript
import{_ as a,c as t,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: Section","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/data/common/interfaces/Section.md","filePath":"api/data/common/interfaces/Section.md","lastUpdated":null}'),i={name:"api/data/common/interfaces/Section.md"};function n(s,e,c,l,d,h){return o(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../">Profectus</a> / <a href="./../">data/common</a> / Section</p><h1 id="interface-section" tabindex="-1">Interface: Section <a class="header-anchor" href="#interface-section" aria-label="Permalink to "Interface: Section""></a></h1><p>An option object for a modifier display as a single section. *</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="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>The base value being modified. *</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/data/common.tsx#L241" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:241</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 call the base amount. 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/data/common.tsx#L245" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:245</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="./../../../game/modifiers/interfaces/Modifier"><code>Modifier</code></a>, <code>"description"</code>></p></blockquote><p>The modifier to be displaying in this section. *</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/data/common.tsx#L239" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:239</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/data/common.tsx#L249" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:249</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>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>A subtitle for this modifier, e.g. to explain the context for the modifier. *</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/data/common.tsx#L237" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:237</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>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>string</code>></p></blockquote><p>The header for this modifier. *</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/data/common.tsx#L235" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:235</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 measurement for the base. *</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/data/common.tsx#L243" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:243</a></p><hr><h3 id="visible" tabindex="-1">visible? <a class="header-anchor" href="#visible" aria-label="Permalink to "visible?""></a></h3><blockquote><p><code>optional</code> <strong>visible</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 this section should be currently visible to the player. *</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/data/common.tsx#L247" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:247</a></p>',51)]))}const u=a(i,[["render",n]]);export{p as __pageData,u as default};
|