Paper/patches/api/0426-Replace-ItemFlag.HIDE_...

45 lines
1.8 KiB
Diff

From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Nassim Jahnke <nassim@njahnke.dev>
Date: Thu, 5 Jan 2023 10:45:20 +0100
Subject: [PATCH] Replace ItemFlag.HIDE_POTION_EFFECTS
diff --git a/src/main/java/org/bukkit/inventory/ItemFlag.java b/src/main/java/org/bukkit/inventory/ItemFlag.java
index a4c0469c565b1fea68b828280c7faf81bc6c332c..73ed2d3c4aded81a24489381db16184383e625bb 100644
--- a/src/main/java/org/bukkit/inventory/ItemFlag.java
+++ b/src/main/java/org/bukkit/inventory/ItemFlag.java
@@ -28,10 +28,33 @@ public enum ItemFlag {
/**
* Setting to show/hide potion effects, book and firework information, map
* tooltips, patterns of banners, and enchantments of enchanted books.
+ * @deprecated misleading name and description, use {@link #HIDE_ITEM_SPECIFICS}
*/
+ @Deprecated // Paper
HIDE_POTION_EFFECTS,
/**
* Setting to show/hide dyes from coloured leather armour
*/
HIDE_DYE;
+ // Paper start
+ /**
+ * Setting to show/hide item-specific information, including, but not limited to:
+ * <ul>
+ * <li>Potion effects on potions, tipped arrows, and suspicious stew</li>
+ * <li>Enchanted book enchantments</li>
+ * <li>Book author and generation</li>
+ * <li>Record names</li>
+ * <li>Patterns of banners and shields</li>
+ * <li>Fish bucket variants</li>
+ * <li>Instrument item descriptions (i.e. goat horn sounds)</li>
+ * <li>Map data</li>
+ * <li>Firework data</li>
+ * <li>Crossbow projectile info</li>
+ * <li>Bundle fullness</li>
+ * <li>Shulker box contents</li>
+ * <li>Spawner descriptions</li>
+ * </ul>
+ */
+ public static final ItemFlag HIDE_ITEM_SPECIFICS = HIDE_POTION_EFFECTS;
+ // Paper end
}