Improved TranslatableItem#apply documentation

anjoismysign · Mar 8, 2024 · 6d08fd4 · 6d08fd4
1 parent 3a51162
commit 6d08fd4
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/main/java/us/mytheria/bloblib/entities/translatable/TranslatableItem.java b/src/main/java/us/mytheria/bloblib/entities/translatable/TranslatableItem.java
@@ -208,7 +208,10 @@ default ItemStack getClone() {
 
     /**
      * Applies the TranslatableItem to an existing ItemStack without overwriting its data.
-     * It only applies the displayname and lore!
+     * This doesn't translate an already valid TranslatableItem instance!
+     * It only applies the display name and lore.
+     * It also sets the locale and reference in the ItemStack's NBT, making it a valid TranslatableItem instance.
+     * This method is useful in cases of which another plugin manages ItemStacks.
      *
      * @param itemStack The ItemStack to apply the TranslatableItem to.
      * @param locale    The locale to apply.
@@ -237,7 +240,10 @@ default void apply(@NotNull ItemStack itemStack, @NotNull String locale) {
 
     /**
      * Applies the TranslatableItem to an existing ItemStack without overwriting its data.
-     * It only applies the displayname and lore!
+     * This doesn't translate an already valid TranslatableItem instance!
+     * It only applies the display name and lore.
+     * It also sets the locale and reference in the ItemStack's NBT, making it a valid TranslatableItem instance.
+     * This method is useful in cases of which another plugin manages ItemStacks.
      *
      * @param itemStack The ItemStack to apply the TranslatableItem to.
      * @param player    The player to apply the TranslatableItem to.