profectus-docs/assets/api_game_modifiers_interfaces_AdditiveModifierOptions.md.BT0TRtrT.js

import{_ as a,c as r,a0 as t,o as i}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Interface: AdditiveModifierOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/modifiers/interfaces/AdditiveModifierOptions.md","filePath":"api/game/modifiers/interfaces/AdditiveModifierOptions.md","lastUpdated":null}'),o={name:"api/game/modifiers/interfaces/AdditiveModifierOptions.md"};function d(n,e,s,c,l,f){return i(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../">Profectus</a> / <a href="./../">game/modifiers</a> / AdditiveModifierOptions</p><h1 id="interface-additivemodifieroptions" tabindex="-1">Interface: AdditiveModifierOptions <a class="header-anchor" href="#interface-additivemodifieroptions" aria-label="Permalink to &quot;Interface: AdditiveModifierOptions&quot;">​</a></h1><p>An object that configures an additive modifier via <a href="./../functions/createAdditiveModifier">createAdditiveModifier</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="addend" tabindex="-1">addend <a class="header-anchor" href="#addend" aria-label="Permalink to &quot;addend&quot;">​</a></h3><blockquote><p><strong>addend</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>&gt;</p></blockquote><p>The amount to add to the input value.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L47" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:47</a></p><hr><h3 id="description" tabindex="-1">description? <a class="header-anchor" href="#description" aria-label="Permalink to &quot;description?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>description</strong>: <a href="./../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a>&lt;<a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>&gt;</p></blockquote><p>Description of what this modifier is doing.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L49" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:49</a></p><hr><h3 id="enabled" tabindex="-1">enabled? <a class="header-anchor" href="#enabled" aria-label="Permalink to &quot;enabled?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>enabled</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>boolean</code>&gt;</p></blockquote><p>A MaybeRefOrGetter that will be processed and passed directly into the returned modifier.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L51" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:51</a></p><hr><h3 id="smallerisbetter" tabindex="-1">smallerIsBetter? <a class="header-anchor" href="#smallerisbetter" aria-label="Permalink to &quot;smallerIsBetter?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>smallerIsBetter</strong>: <code>boolean</code></p></blockquote><p>Determines if numbers larger or smaller than 0 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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L53" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:53</a></p>',27)]))}const m=a(o,[["render",d]]);export{h as __pageData,m as default};