profectus-docs/assets/api_interfaces_game_modifiers.MultiplicativeModifierOptions.md.838ca9ef.js

2 lines
4 KiB
JavaScript
Raw Normal View History

import{_ as e,c as i,o as a,N as t}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Interface: MultiplicativeModifierOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/modifiers.MultiplicativeModifierOptions.md","lastUpdated":null}'),r={name:"api/interfaces/game/modifiers.MultiplicativeModifierOptions.md"},o=t('<h1 id="interface-multiplicativemodifieroptions" tabindex="-1">Interface: MultiplicativeModifierOptions <a class="header-anchor" href="#interface-multiplicativemodifieroptions" aria-label="Permalink to &quot;Interface: MultiplicativeModifierOptions&quot;"></a></h1><p><a href="./../../modules/game/modifiers">game/modifiers</a>.MultiplicativeModifierOptions</p><p>An object that configures an multiplicative modifier via <a href="./../../modules/game/modifiers#createmultiplicativemodifier">createMultiplicativeModifier</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="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" 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#L114" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:114</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-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#L116" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:116</a></p><hr><h3 id="multiplier" tabindex="-1">multiplier <a class="header-anchor" href="#multiplier" aria-label="Permalink to &quot;multiplier&quot;"></a></h3><p>• <strong>multiplier</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 multiply the input value by.</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#L112" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:112</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 1 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#L118" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:118</a></p>',27),n=[o];function l(s,d,c,p,f,m){return a(),i("div",null,n)}const b=e(r,[["render",l]]);export{h