From bbd910119f5bb66cf492e5fbc57cf2ecfb332a77 Mon Sep 17 00:00:00 2001
From: Pear <20259871+TheRealPear@users.noreply.github.com>
Date: Sat, 13 Apr 2024 00:59:19 -0400
Subject: [PATCH] Rewrite and add consumables (#116)

* Rewrite and add consumables

Building on top of #90

Signed-off-by: TheRealPear <20259871+TheRealPear@users.noreply.github.com>
Co-Authored-By: Half <41559602+OhPointFive@users.noreply.github.com>

* Merge kit attribute into action attribute

Signed-off-by: TheRealPear <20259871+TheRealPear@users.noreply.github.com>

---------

Signed-off-by: TheRealPear <20259871+TheRealPear@users.noreply.github.com>
Co-authored-by: Half <41559602+OhPointFive@users.noreply.github.com>
---
 docs/modules/gear/consumables.mdx | 67 +++++++++++++++++++++++++++++++
 docusaurus.config.js              |  2 +-
 sidebars.js                       |  1 +
 3 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 docs/modules/gear/consumables.mdx

diff --git a/docs/modules/gear/consumables.mdx b/docs/modules/gear/consumables.mdx
new file mode 100644
index 00000000..c686f79d
--- /dev/null
+++ b/docs/modules/gear/consumables.mdx
@@ -0,0 +1,67 @@
+---
+id: consumables
+title: Consumables
+---
+
+Consumables are items that can be made "edible" to the player and "consuming" it will allow them to run an action or receive a kit.
+It can be defined and applied to items in [kits](/docs/modules/gear/kits).
+When consumed, these items can trigger [actions](/docs/modules/mechanics/actions-triggers), and override vanilla eating or drinking behavior.
+
+#### Consumables Element
+
+<div className="table-container">
+  | Element | Description |
+  |---|---|
+  | `<consumables> </consumables>` | Node containing the consumables definitions. |
+
+  | Sub-elements ||
+  |---|---|
+  | `<consumable> </consumable>` | An individual consumable. |
+</div>
+
+#### Consumable Attributes
+
+<div className="table-container">
+  | Attribute | Description | Value | Default |
+  |---|---|---|---|
+  | `id` | <span className="badge badge--danger">Required</span>Unique identifier used to reference this consumable from other places in the XML. | <span className="badge badge--primary">String</span> |
+  | `action`&#124;`kit` | <span className="badge badge--danger">Required</span>Run the specified action upon consumption. | [Action ID](/docs/modules/mechanics/actions-triggers) |
+  | `on` | <span className="badge badge--danger">Required</span>Specify how the consumable should be used.<br />**Note:** The only action currently supported is `eat`. In the future, more actions such as clicking will be supported. | `eat` |
+  | `override` | Consumable is affected by vanilla behaviors, such as giving the player potion effects.<br />*This is useful when using potion bottles and golden apples as the consumable item.* | <span className="badge badge--primary">true/false</span> | true |
+</div>
+
+### Examples
+
+```xml
+<!-- Create the consumable "template" -->
+<consumables>
+    <consumable id="porkchop-that-says-yum" action="say-yum" on="eat" override="false"/>
+</consumables>
+<!-- Apply the consumable to an item -->
+<kits>
+    <kit id="spawn">
+        <item slot="1" amount="5" consumable="porkchop-that-says-yum" material="pork"/>
+    </kit>
+</kits>
+<!-- Define the action the consumable will run -->
+<actions>
+    <message id="say-yum" text="Yum!"/>
+</actions>
+```
+
+```xml
+<!-- Create the consumable "template" -->
+<consumables>
+    <consumable id="fast-apple" kit="speed-kit" on="eat"/>
+</consumables>
+<kits>
+    <!-- Apply the consumable to an item -->
+    <kit id="spawn">
+        <item slot="1" consumable="fast-apple" name="Fast Apple" material="golden apple"/>
+    </kit>
+    <!-- Define the kit the consumable gives you -->
+    <kit id="speed-kit">
+        <effect duration="4" amplifier="10">speed</effect>
+    </kit>
+</kits>
+```
diff --git a/docusaurus.config.js b/docusaurus.config.js
index db8083cf..5ce07e25 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -85,7 +85,7 @@ const config = {
      announcementBar: {
       id: 'new_features',
       content:
-        'New Features: <a href="/docs/modules/general/main#map-variants">Map Variants</a>, <a href="/docs/modules/general/main#constants">Constants</a>, <a href="/docs/modules/blocks/structures">Structures</a>, and <a href="/docs/modules/blocks/enderchests">Ender Chests</a>',
+        'New Features: <a href="/docs/modules/gear/consumables">Consumables</a>, <a href="/docs/modules/general/main#map-variants">Map Variants</a>, <a href="/docs/modules/general/main#constants">Constants</a>, and <a href="/docs/modules/blocks/structures">Structures</a>',
       backgroundColor: '#fafbfc',
       textColor: '#091E42',
       isCloseable: true,
diff --git a/sidebars.js b/sidebars.js
index 772031a3..9f9917a5 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -68,6 +68,7 @@ const sidebars = {
       "modules/gear/crafting",
       "modules/gear/repair-remove-keep",
       "modules/gear/projectiles",
+      "modules/gear/consumables",
       "modules/gear/tnt",
       "modules/gear/kill-rewards",
       "modules/gear/lootables"],