Changes

Page history
Added onFurnitureInventoryOpen/Close and organized the page a bit authored by Amy's avatar Amy
Show whitespace changes
Inline Side-by-side
Skills/Triggers.md
View page @ 47b77837
Crucible supports all triggers that generally make sense, and also adds a bunch of new skill triggers for use by items. This list contains all compatible triggers. Crucible supports all other triggers that would generally make sense, and also adds new triggers designed specifically for items, blocks and furniture. This page contains all possible triggers.
| Trigger | When it fires… |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| [[_TOC_]]
# Item Triggers
| Trigger | When it fires... |
|----------------------------------------|--------------------------------------------------------------|
| onAttack | When the player hits another entity | | onAttack | When the player hits another entity |
| onBlockBreak | When the player breaks a block |
| onBlockPlace | When the player places a block |
| onConsume | Triggered if the item is food or a potion that is eaten | | onConsume | Triggered if the item is food or a potion that is eaten |
| onCrouch | When the player crouches | | onCrouch | When the player crouches |
| onUnCrouch | When the player stops crouching | | onUnCrouch | When the player stops crouching |
...@@ -40,13 +43,31 @@ Crucible supports all triggers that generally make sense, and also adds a bunch ...@@ -40,13 +43,31 @@ Crucible supports all triggers that generally make sense, and also adds a bunch
| onPickup | When a player picks up the crucible item | | onPickup | When a player picks up the crucible item |
| onHold | When the player holds an item | | onHold | When the player holds an item |
| onUnHeld | When the player switches off the item from their hotbar | | onUnHeld | When the player switches off the item from their hotbar |
| onFurnitureStateChange | When the [Furniture](/wikis/Furniture) changes state. Despite the name, this is triggered every time the [SetFurnitureState](/Skills/Mechanics/setfurniturestate) mechanic is used, regardless of the state not actually changing |
| onBlockRotate | When the [Furniture](/wikis/Furniture) is rotated |
| onJump | When the Player jumps | | onJump | When the Player jumps |
| onPaint | When a [Paint Brush](Paint-Brush) paints a furniture | | onPaint | When a [Paint Brush](Paint-Brush) paints a furniture |
Example Usages # Custom Block Triggers
-------- These triggers can be used with [Custom Blocks](/Custom-Blocks)
| Trigger | When it fires... |
|----------------------------------------|--------------------------------------------------------------|
| onBlockBreak | When the player breaks the custom block |
| onBlockPlace | When the player places the custom block |
# Furniture Triggers
All these triggers can be used with [Furnitures](https://git.mythiccraft.io/mythiccraft/mythiccrucible/-/wikis/Furniture)
| Trigger | When it fires... |
|----------------------------------------|--------------------------------------------------------------|
| onBlockPlace | When the furniture is placed |
| onBlockBreak | When the furniture is broken |
| onBlockRotate | When the furniture is rotated |
| onFurnitureStateChange | When the furnitures state changed. This is triggered every time the [SetFurnitureState](/Skills/Mechanics/setfurniturestate) mechanic is used, even if the state stays the same. |
| onFurnitureInventoryOpen | When the [Furniture Inventory](/Skills/Mechanics/furnitureinventory) is opened |
| onFurnitureInventoryClose | When the [Furniture Inventory](/Skills/Mechanics/furnitureinventory) is closed |
| onInteract | When a player right clicks the furniture |
| onPaint | When a paintbrush is used on a furniture |
# Examples
**MythicKeys Triggers** **MythicKeys Triggers**
```yml ```yml
... ...
......