profectus-docs/assets/api_interfaces_game_modifiers.ModifierSectionOptions.md.55a2f406.js

import{_ as e,c as a,o as i,N as t}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: ModifierSectionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/modifiers.ModifierSectionOptions.md","lastUpdated":null}'),r={name:"api/interfaces/game/modifiers.ModifierSectionOptions.md"},o=t('<h1 id="interface-modifiersectionoptions" tabindex="-1">Interface: ModifierSectionOptions <a class="header-anchor" href="#interface-modifiersectionoptions" aria-label="Permalink to &quot;Interface: ModifierSectionOptions&quot;">​</a></h1><p><a href="./../../modules/game/modifiers">game/modifiers</a>.ModifierSectionOptions</p><p>An object that configures a modifier section via <a href="./../../modules/game/modifiers#createmodifiersection">createModifierSection</a>.</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/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></p><p>The base value that&#39;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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L305" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:305</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/features/feature#coercablecomponent"><code>CoercableComponent</code></a></p><p>The label to use for the base value. 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/game/modifiers.tsx#L309" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:309</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="./modifiers.Modifier"><code>Modifier</code></a>, <code>&quot;description&quot;</code>&gt;</p><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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L303" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:303</a></p><hr><h3 id="smallerisbetter" tabindex="-1">smallerIsBetter <a class="header-anchor" href="#smallerisbetter" aria-label="Permalink to &quot;smallerIsBetter&quot;">​</a></h3><p>• <code>Optional</code> <strong>smallerIsBetter</strong>: <code>boolean</code></p><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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L311" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:311</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>: <code>string</code></p><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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L301" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:301</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>: <code>string</code></p><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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L299" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:299</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 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 &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/modifiers.tsx#L307" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:307</a></p>',45),n=[o];function s(d,c,f,l,h,p){return i(),a("div",null,n)}const b=e(r,[["render",s]]);export{u as __pageData,b as default};