|
|
Spell Reagents are resources you use to cast a spell - the most standard being something like "mana". MythicRPG comes with a couple hardcoded reagents, but also allows you to create custom reagents that you can manipulate however you want, including by scaling using the stat system.
|
|
|
|
|
|
## Hardcoded Reagents
|
|
|
| Hardcoded Reagents | Description |
|
|
|
|--------------------------|---------------------------------------------------------------------|
|
|
|
| health | Requires health to cast. Damages you when the spell is used. |
|
|
|
| food | Requires food to cast. Consumes food when the spell is used. |
|
|
|
|
|
|
## Custom Reagents
|
|
|
Custom Reagents are defined in a `reagents.yml` in any pack folder.
|
|
|
|
|
|
### Custom Stat Options
|
|
|
| Option | Description |
|
|
|
|--------------------------|---------------------------------------------------------------------|
|
|
|
| Display | How the reagent is displayed in messages and GUIs. |
|
|
|
| MinValue | The minimum value of the reagent. Usually zero. |
|
|
|
| MaxValue | The max value of the reagent. Can be a stat using `stat.[stat_name]` |
|
|
|
| Global: true | If true, players always have this reagent. |
|
|
|
|
|
|
### Custom Reagent Placeholders
|
|
|
Custom Reagent values can be displayed using PlaceholderAPI placeholders - we recommend using our HappyHUD plugin for this to create nice-looking reagent bars.
|
|
|
|
|
|
- `%mythic_reagent_[name]%` - The reagent's current value
|
|
|
- `%mythic_reagent_max_[name]%` - The reagent's maximum value
|
|
|
|
|
|
### Example `reagents.yml` file
|
|
|
```
|
|
|
Mana:
|
|
|
Display: 'Mana'
|
|
|
MinValue: 0
|
|
|
MaxValue: stat.MAX_MANA
|
|
|
Global: true
|
|
|
``` |
|
|
\ No newline at end of file |