profectus-docs/assets/api_interfaces_data_common.Section.md.8ef32035.js

1 line
5.7 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Interface: Section","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/data/common.Section.md","lastUpdated":null}'),r={name:"api/interfaces/data/common.Section.md"},i=o('<h1 id="interface-section" tabindex="-1">Interface: Section <a class="header-anchor" href="#interface-section" aria-label="Permalink to &quot;Interface: Section&quot;"></a></h1><p><a href="./../../modules/data/common">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-label="Permalink to &quot;Properties&quot;"></a></h2><h3 id="base" tabindex="-1">base <a class="header-anchor" href="#base" aria-label="Permalink to &quot;base&quot;"></a></h3><p>• <code>Optional</code> <strong>base</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/lib/break_eternity#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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L249" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:249</a></p><hr><h3 id="basetext" tabindex="-1">baseText <a class="header-anchor" href="#basetext" aria-label="Permalink to &quot;baseText&quot;"></a></h3><p>• <code>Optional</code> <strong>baseText</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/feature#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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L253" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:253</a></p><hr><h3 id="modifier" tabindex="-1">modifier <a class="header-anchor" href="#modifier" aria-label="Permalink to &quot;modifier&quot;"></a></h3><p>• <strong>modifier</strong>: <a href="./../../modules/util/common#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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L247" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:247</a></p><hr><h3 id="subtitle" tabindex="-1">subtitle <a class="header-anchor" href="#subtitle" aria-label="Permalink to &quot;subtitle&quot;"></a></h3><p>• <code>Optional</code> <strong>subtitle</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L245" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:245</a></p><hr><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-label="Permalink to &quot;title&quot;"></a></h3><p>• <strong>title</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L243" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:243</a></p><hr><h3 id="unit" tabindex="-1">unit <a class="header-anchor" href="#unit" aria-label="Permalink to &quot;unit&quot;"></a></h3><p>• <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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L251" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:251</a></p><hr><h3 id="visible" tabindex="-1">visible <a class="header-anchor" href="#visible" aria-label="Permalink to &quot;visible&quot;"></a></h3><p>• <code>Optional</code> <strong>visible</strong>: <a href="./../../modules/util/computed#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-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L255" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:255</a></p>',45),n=[i];function d(c,s,l,h,f,u){return t(),a("div",null,n)}const b=e(r,[["render",d]]);export{p as __pageData,b as default};