Skip to content

Commit

Permalink
Merge pull request #39 from Cokenpizza/master
Browse files Browse the repository at this point in the history
Update Docs for Auxilor/libreforge#119
  • Loading branch information
WillFP authored Sep 25, 2023
2 parents 2ba16b4 + d40885d commit 5522be3
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/effects/all-effects/give_food.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ Gives the player food
- id: give_food
args:
amount: 2 # The amount of food to give/take (allows negative values)
respect-vanilla-limits: true # (Optional, defaults to false) if the added food should respect vanilla minimum food (0) and maximum food (20)
...other config (eg triggers, filters, mutators, etc)
```
13 changes: 13 additions & 0 deletions docs/effects/all-effects/give_saturation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `give_saturation`
#### Triggered Effect

Gives the player saturation

# Example Config
```yaml
- id: give_saturation
args:
amount: 1.0 # The amount of saturation to give/take (allows negative values)
respect-vanilla-limits: true # (Optional, defaults to false) if the added saturation should respect vanilla minimum saturation (0.0) and maximum saturation (20.0 or player's current food level, whichever is lower)
...other config (eg triggers, filters, mutators, etc)
```
3 changes: 2 additions & 1 deletion docs/effects/all-effects/item_durability_multiplier.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# `item_durability_multiplier`
#### Permanent Effect
#### Triggered Effect

Multiplies item durability (only works if holders are items, e.g. in EcoEnchants, EcoItems, etc.)

Expand All @@ -10,4 +10,5 @@ Item durability cannot actually be changed, so this functions like unbreaking wh
- id: item_durability_multiplier
args:
multiplier: 1.5 # The multiplier for the durability
...other config (eg triggers, filters, mutators, etc)
```
12 changes: 12 additions & 0 deletions docs/effects/all-effects/set_food.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# `set_food`
#### Triggered Effect

Sets the player's food

# Example Config
```yaml
- id: set_food
args:
amount: 1 # The food level to set
...other config (eg triggers, filters, mutators, etc)
```
12 changes: 12 additions & 0 deletions docs/effects/all-effects/set_saturation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# `set_saturation`
#### Triggered Effect

Sets the player's saturation

# Example Config
```yaml
- id: set_saturation
args:
amount: 10.0 # The saturation level to set
...other config (eg triggers, filters, mutators, etc)
```

0 comments on commit 5522be3

Please sign in to comment.