# HumeShield

This custom module modifies player Hume Shield values based on specific game events. It allows configuration of the Hume Shield regeneration rate, maximum Hume Shield capacity, regeneration cooldown, and the events that trigger these changes.

### Configuration

| Value           | Description                                                                                                                        |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `RegenRate`     | The rate at which the player's Hume Shield regenerates.                                                                            |
| `MaxHumeShield` | The maximum amount of Hume Shield the player can possess.                                                                          |
| `RegenCoolDown` | The cooldown period before Hume Shield regeneration begins.                                                                        |
| `Trigger`       | The game event(s) that will trigger the Hume Shield modifications. Valid options include `OnAdded`, `OnChangedItem`, `OnUsedItem`. |

### Example

```yaml
custom_modules:
  HumeShield:
  - RegenRate: 10.5
    MaxHumeShield: 100
    RegenCoolDown: 5.0
    Trigger: 'OnAdded, OnChangedItem'
```


---

# Agent Instructions: 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:

```
GET https://docs.uci.ucserver.it/uncomplicatedcustomitems/prerelease-content/custommodules/humeshield.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.