1 line
7.1 KiB
JavaScript
1 line
7.1 KiB
JavaScript
import{_ as a,c as r,a0 as i,o as t}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: Modifier","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/modifiers/interfaces/Modifier.md","filePath":"api/game/modifiers/interfaces/Modifier.md","lastUpdated":null}'),o={name:"api/game/modifiers/interfaces/Modifier.md"};function n(s,e,c,d,l,h){return t(),r("div",null,e[0]||(e[0]=[i('<p><a href="./../../../">Profectus</a> / <a href="./../">game/modifiers</a> / Modifier</p><h1 id="interface-modifier" tabindex="-1">Interface: Modifier <a class="header-anchor" href="#interface-modifier" aria-label="Permalink to "Interface: Modifier""></a></h1><p>An object that can be used to apply or unapply some modification to a number. Being reversible requires the operation being invertible, but some features may rely on that. Descriptions can be optionally included for displaying them to the player. The built-in modifier creators are designed to display the modifiers using <a href="./../functions/createModifierSection">createModifierSection</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="apply" tabindex="-1">apply() <a class="header-anchor" href="#apply" aria-label="Permalink to "apply()""></a></h3><blockquote><p><strong>apply</strong>: (<code>gain</code>) => <a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p></blockquote><p>Applies some operation on the input and returns the result.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="gain" tabindex="-1">gain <a class="header-anchor" href="#gain" aria-label="Permalink to "gain""></a></h5><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L21" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:21</a></p><hr><h3 id="description" tabindex="-1">description? <a class="header-anchor" href="#description" aria-label="Permalink to "description?""></a></h3><blockquote><p><code>optional</code> <strong>description</strong>: <a href="./../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>></p></blockquote><p>A description of this modifier.</p><h4 id="see" tabindex="-1">See <a class="header-anchor" href="#see" aria-label="Permalink to "See""></a></h4><p><a href="./../functions/createModifierSection">createModifierSection</a>.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L35" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:35</a></p><hr><h3 id="enabled" tabindex="-1">enabled? <a class="header-anchor" href="#enabled" aria-label="Permalink to "enabled?""></a></h3><blockquote><p><code>optional</code> <strong>enabled</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code>></p></blockquote><p>Whether or not this modifier should be considered enabled. Typically for use with modifiers passed into <a href="./../functions/createSequentialModifier">createSequentialModifier</a>.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L30" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:30</a></p><hr><h3 id="getformula" tabindex="-1">getFormula()? <a class="header-anchor" href="#getformula" aria-label="Permalink to "getFormula()?""></a></h3><blockquote><p><code>optional</code> <strong>getFormula</strong>: (<code>gain</code>) => <a href="./../../formulas/types/type-aliases/GenericFormula"><code>GenericFormula</code></a></p></blockquote><p>Get a formula for this modifier. Required by some features.</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><h5 id="gain-1" tabindex="-1">gain <a class="header-anchor" href="#gain-1" aria-label="Permalink to "gain""></a></h5><p><code>any</code></p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><a href="./../../formulas/types/type-aliases/GenericFormula"><code>GenericFormula</code></a></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L25" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:25</a></p><hr><h3 id="invert" tabindex="-1">invert()? <a class="header-anchor" href="#invert" aria-label="Permalink to "invert()?""></a></h3><blockquote><p><code>optional</code> <strong>invert</strong>: (<code>gain</code>) => <a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p></blockquote><p>Reverses the operation applied by the apply property. Required by some features.</p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></a></h4><h5 id="gain-2" tabindex="-1">gain <a class="header-anchor" href="#gain-2" aria-label="Permalink to "gain""></a></h5><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h4><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/modifiers.tsx#L23" target="_blank" rel="noreferrer">profectus/src/game/modifiers.tsx:23</a></p>',50)]))}const u=a(o,[["render",n]]);export{p as __pageData,u as default};
|