Requested changes

pmmp · Sep 1, 2024 · f358cf8 · f358cf8
1 parent eb23afc
commit f358cf8
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/src/item/ChorusFruit.php b/src/item/ChorusFruit.php
@@ -90,6 +90,6 @@ public function getCooldownTicks() : int{
 	}
 
 	public function getCooldownTag() : ?string{
-		return VanillaCooldownTags::CHORUS_FRUIT;
+		return ItemCooldownTags::CHORUS_FRUIT;
 	}
 }
diff --git a/src/item/EnderPearl.php b/src/item/EnderPearl.php
@@ -47,6 +47,6 @@ public function getCooldownTicks() : int{
 	}
 
 	public function getCooldownTag() : ?string{
-		return VanillaCooldownTags::ENDER_PEARL;
+		return ItemCooldownTags::ENDER_PEARL;
 	}
 }
diff --git a/src/item/Item.php b/src/item/Item.php
@@ -662,7 +662,7 @@ public function getCooldownTicks() : int{
 	 *
 	 * If tag is null, item state id will be used to store cooldown.
 	 *
-	 * @see VanillaCooldownTags
+	 * @see ItemCooldownTags
 	 */
 	public function getCooldownTag() : ?string{
 		return null;

diff --git a/src/item/VanillaCooldownTags.php → src/item/ItemCooldownTags.php b/src/item/VanillaCooldownTags.php → src/item/ItemCooldownTags.php
@@ -27,12 +27,17 @@
  * Tags used by items to determine their cooldown group.
  * @see Item::getCooldownTag()
  */
-final class VanillaCooldownTags{
+final class ItemCooldownTags{
 
 	private function __construct(){
 		//NOOP
 	}
 
+	/**
+	 * These tag values are not related to Minecraft internal IDs.
+	 * They only share a visual similarity because these are the most obvious values to use.
+	 * Any arbitrary string can be used.
+	 */
 	public const CHORUS_FRUIT = "chorus_fruit";
 	public const ENDER_PEARL = "ender_pearl";
 	public const SHIELD = "shield";