import{_ as e,c as a,o as r,N as t}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: Modifier","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/modifiers.Modifier.md","lastUpdated":null}'),o={name:"api/interfaces/game/modifiers.Modifier.md"},i=t('

Interface: Modifier ​

game/modifiers.Modifier

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 createModifierSection.

Properties ​

apply ​

• apply: (gain: DecimalSource) => DecimalSource

Type declaration ​

▸ (gain): DecimalSource

Applies some operation on the input and returns the result.

Parameters ​
NameType
gainDecimalSource
Returns ​

DecimalSource

Defined in ​

profectus/src/game/modifiers.tsx:22

description ​

• Optional description: ProcessedComputable<CoercableComponent>

A description of this modifier.

See

createModifierSection.

Defined in ​

profectus/src/game/modifiers.tsx:34

enabled ​

• Optional enabled: ProcessedComputable<boolean>

Whether or not this modifier should be considered enabled. Typically for use with modifiers passed into createSequentialModifier.

Defined in ​

profectus/src/game/modifiers.tsx:29

revert ​

• Optional revert: (gain: DecimalSource) => DecimalSource

Type declaration ​

▸ (gain): DecimalSource

Reverses the operation applied by the apply property. Required by some features.

Parameters ​
NameType
gainDecimalSource
Returns ​

DecimalSource

Defined in ​

profectus/src/game/modifiers.tsx:24

',41),d=[i];function n(c,s,l,h,f,p){return r(),a("div",null,d)}const b=e(o,[["render",n]]);export{u as __pageData,b as default};