profectus-docs/assets/api_interfaces_data_common.Section.md.312dd836.js

import{_ as e,c as t,o as a,a as r}from"./app.ab34650d.js";const m=JSON.parse('{"title":"Interface: Section","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"base","slug":"base"},{"level":3,"title":"baseText","slug":"basetext"},{"level":3,"title":"modifier","slug":"modifier"},{"level":3,"title":"subtitle","slug":"subtitle"},{"level":3,"title":"title","slug":"title"},{"level":3,"title":"unit","slug":"unit"},{"level":3,"title":"visible","slug":"visible"}],"relativePath":"api/interfaces/data/common.Section.md","lastUpdated":null}'),o={name:"api/interfaces/data/common.Section.md"},i=r('<h1 id="interface-section" tabindex="-1">Interface: Section <a class="header-anchor" href="#interface-section" aria-hidden="true">#</a></h1><p><a href="./../../modules/data/common.html">data/common</a>.Section</p><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-hidden="true">#</a></h2><h3 id="base" tabindex="-1">base <a class="header-anchor" href="#base" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>base</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>&gt;</p><p>The base value being modified. *</p><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/data/common.tsx#L244" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:244</a></p><hr><h3 id="basetext" tabindex="-1">baseText <a class="header-anchor" href="#basetext" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>baseText</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><p>The label to call the base amount. Defaults to &quot;Base&quot;. *</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/data/common.tsx#L248" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:248</a></p><hr><h3 id="modifier" tabindex="-1">modifier <a class="header-anchor" href="#modifier" aria-hidden="true">#</a></h3><p>\u2022 <strong>modifier</strong>: <a href="./../../modules/util/common.html#withrequired"><code>WithRequired</code></a>&lt;<a href="../game/modifiers.Modifier"><code>Modifier</code></a>, <code>&quot;description&quot;</code>&gt;</p><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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L242" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:242</a></p><hr><h3 id="subtitle" tabindex="-1">subtitle <a class="header-anchor" href="#subtitle" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>subtitle</strong>: <code>string</code></p><p>A subtitle for this modifier, e.g. to explain the context for the modifier. *</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L240" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:240</a></p><hr><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-hidden="true">#</a></h3><p>\u2022 <strong>title</strong>: <code>string</code></p><p>The header for this modifier. *</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L238" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:238</a></p><hr><h3 id="unit" tabindex="-1">unit <a class="header-anchor" href="#unit" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>unit</strong>: <code>string</code></p><p>The unit of measurement for the base. *</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L246" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:246</a></p><hr><h3 id="visible" tabindex="-1">visible <a class="header-anchor" href="#visible" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>visible</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not this section should be currently visible to the player. *</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/data/common.tsx#L250" target="_blank" rel="noopener noreferrer">profectus/src/data/common.tsx:250</a></p>',45),n=[i];function d(s,c,h,l,f,p){return a(),t("div",null,n)}var b=e(o,[["render",d]]);export{m as __pageData,b as default};