> For the complete documentation index, see [llms.txt](https://maraudical.gitbook.io/status-effects-framework/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maraudical.gitbook.io/status-effects-framework/type-specifics/classes/effect.md).

# Effect

### Description

[Effects](/status-effects-framework/type-specifics/classes/effect.md) dynamically adjust the value of [StatusVariables](/status-effects-framework/type-specifics/classes/statusvariable.md).

### Properties

<table data-full-width="true"><thead><tr><th width="250">Name</th><th width="250">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>StatusName</code></td><td><a href="/pages/C7pBt5Kep8pMjla2KRJw">StatusName</a></td><td>The <a href="/pages/C7pBt5Kep8pMjla2KRJw">StatusName</a> effected.</td></tr><tr><td><code>ValueModifier</code></td><td><a href="#value-modifier">ValueModifier</a></td><td>Specific to numeric value types. Defines how the final value should be calculated.</td></tr><tr><td><code>UseBaseValue</code></td><td>bool</td><td>When true it will use the <a href="/pages/FzvWc4ygR9G3YZgoRwuJ">StatusEffectData's</a> base value as the <a href="/pages/s7FQEi53BGgrVgcovWko">Effect</a> value.</td></tr><tr><td><code>Priority</code></td><td>int</td><td>The effect with the highest priority will take precedence.</td></tr><tr><td><code>Value</code></td><td>float, int, bool</td><td>The value of the effect determined by the <a href="/pages/C7pBt5Kep8pMjla2KRJw">StatusName</a> type. This value can be overridden by the base value of the <a href="/pages/FzvWc4ygR9G3YZgoRwuJ">StatusEffectData</a> but for ints the value will be floored, and for bools the value is false for 0 and true for anything else.</td></tr></tbody></table>

### Value Modifier

The value modifier will tell the [StatusVariable](/status-effects-framework/type-specifics/classes/statusvariable.md) how to calculate the effect value into its final value. The equation for how modifier values are added is:&#x20;

`( Base + Additive ) * Multiplicative + PostAdditive = Final Value`

<table data-full-width="true"><thead><tr><th width="250">Name</th><th>Description</th></tr></thead><tbody><tr><td><code>Additive</code></td><td>Will simply add the effect value to the <a href="/pages/RAQ58e3Q2H5m3W9tMHPY">StatusVariable</a> base value.</td></tr><tr><td><code>Multiplicative</code></td><td>The percentage in decimal form that the <a href="/pages/RAQ58e3Q2H5m3W9tMHPY">StatusVariable</a> will multiply its <code>Base + Additive</code> value.</td></tr><tr><td><code>PostAdditive</code></td><td>Similar to additive, except that it is evaluated after the Multiplicative value so it will not be multiplied.</td></tr><tr><td><code>Maximum</code></td><td>Clamps the maximum value of the <a href="/pages/RAQ58e3Q2H5m3W9tMHPY">StatusVariable</a>. The calculated maximum may change depending on the effect priority.</td></tr><tr><td><code>Minimum</code></td><td>Clamps the minimum value of the <a href="/pages/RAQ58e3Q2H5m3W9tMHPY">StatusVariable</a>. The calculated minimum may change depending on the effect priority.</td></tr><tr><td><code>Overwrite</code></td><td>Overwrites value of the <a href="/pages/RAQ58e3Q2H5m3W9tMHPY">StatusVariable</a>. The calculated value may change depending on the effect priority.</td></tr></tbody></table>
