> For the complete documentation index, see [llms.txt](https://malbersanimations.gitbook.io/animal-controller/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://malbersanimations.gitbook.io/animal-controller/global-components/stats/stat-modifiers.md).

# Stat Modifier

## Overview

Stat Modifier is a Struct class to help modify Stats on the Stats Component

## Properties

![](/files/-M5DvWDkjlvObEaYjDt7)

### ID

ID value of the Stat

### Value

Amount used on the Modify Action.

## Modify

Actions to do to the Stat

<figure><img src="/files/Dbf2tMoMnj0cmxHgMvgS" alt=""><figcaption></figcaption></figure>

#### Add Value

Adds to the [**Value** ](/animal-controller/global-components/stats.md#value)of the Stat, the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Set Value

Sets the  [**Value** ](/animal-controller/global-components/stats.md#value)of the Stat, the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Subtract Value

Subtracts to the  [**Value** ](/animal-controller/global-components/stats.md#value)of the Stat, the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Modify Max Value

Modify to the [**Maximum Value**](/animal-controller/global-components/stats.md#max-value) of the Stat, the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### **Set Max Value**

Set to the [**Maximum Value**](/animal-controller/global-components/stats.md#max-value) of the Stat equals to the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Degenerate

Start [**Degenerating** ](/animal-controller/global-components/stats.md#regenerate)the Stat. Also Set the[ **Degenerate Rate**](/animal-controller/global-components/stats.md#degenerate-rate) of the stat equals to the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Stop Degenerate

Stops [**Degenerating** ](/animal-controller/global-components/stats.md#regenerate)the Stat. Also Set the[ **Degenerate Rate**](/animal-controller/global-components/stats.md#degenerate-rate) of the stat equals to the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Regenerate

Start [**Regenerating** ](/animal-controller/global-components/stats.md#regenerate)the Stat. Also Set the [**Regenerate Rate**](/animal-controller/global-components/stats.md#regenerate-rate) of the stat equals to the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Stop Regenerate

Stops [**Regenerating** ](/animal-controller/global-components/stats.md#regenerate)the Stat. Also Set the [**Regenerate Rate**](/animal-controller/global-components/stats.md#regenerate-rate) of the stat equals to the [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)parameter

#### Reset

Reset the Stat to its [**Reset Value**](/animal-controller/global-components/stats.md#reset-to).

#### Reduce by Percent

Reduces to the [**Value** ](/animal-controller/global-components/stats.md#value)of the Stat by a [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)**represented in percent.**

#### Increase by Percent

Increases to the [**Value** ](/animal-controller/global-components/stats.md#value)of the Stat by a [**value** ](/animal-controller/global-components/stats/stat-modifiers.md#value)**represented in percent.**

#### **Multiplier**

Set the multiplier value of the stat

#### **Reset to Max**

Reset the stat to the maximum value

#### **Reset to Min**

Reset the stat to the minimum value

#### **Enable**

Enables/Disables the stat

#### **Immune**

Sets the stat to Immune so it can't be altered


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://malbersanimations.gitbook.io/animal-controller/global-components/stats/stat-modifiers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.