ProfectusInterface: 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
| Name | Type |
|---|---|
gain | DecimalSource |
Returns
Defined in
profectus/src/game/modifiers.tsx:21
description
• Optional description: ProcessedComputable<CoercableComponent>
A description of this modifier.
See
Defined in
profectus/src/game/modifiers.tsx:33
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:28
revert
• Optional revert: (gain: DecimalSource) => DecimalSource
Type declaration
▸ (gain): DecimalSource
Reverses the operation applied by the apply property. Required by some features.
Parameters
| Name | Type |
|---|---|
gain | DecimalSource |