profectus-docs/assets/api_interfaces_game_modifiers.AdditiveModifierOptions.md.1da8f361.js

1 line
3.9 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 i,N as t}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: AdditiveModifierOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/modifiers.AdditiveModifierOptions.md","lastUpdated":null}'),r={name:"api/interfaces/game/modifiers.AdditiveModifierOptions.md"},o=t('<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><a href="./../../modules/game/modifiers">game/modifiers</a>.AdditiveModifierOptions</p><p>An object that configures an additive modifier via <a href="./../../modules/game/modifiers#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><p>• <strong>addend</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 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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/game/modifiers.tsx#L51" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:51</a></p><hr><h3 id="description" tabindex="-1">description <a class="header-anchor" href="#description" aria-label="Permalink to &quot;description&quot;"></a></h3><p>• <code>Optional</code> <strong>description</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>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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/game/modifiers.tsx#L53" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:53</a></p><hr><h3 id="enabled" tabindex="-1">enabled <a class="header-anchor" href="#enabled" aria-label="Permalink to &quot;enabled&quot;"></a></h3><p>• <code>Optional</code> <strong>enabled</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>A computable 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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/game/modifiers.tsx#L55" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:55</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 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://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/game/modifiers.tsx#L57" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:57</a></p>',27),d=[o];function n(s,c,l,f,p,h){return i(),a("div",null,d)}const b=e(r,[["render",n]]);export{u as __pageData,b as default};