The player holding the book
- * @param mainHandWhether the player is holding the book in its main hand or its off hand
+ * @param itemSlotThe item slot of the held book
*/ - protected void unSignHeldBook(@NotNull Player player, boolean mainHand) { + protected void unSignHeldBook(@NotNull Player player, @NotNull ItemSlot itemSlot) { //Get the old book - BookMeta oldMetadata = InventoryUtil.getHeldBookMetadata(player, mainHand); + BookMeta oldMetadata = InventoryUtil.getHeldBookMetadata(player, itemSlot); if (oldMetadata == null) { new FormatBuilder(Translatable.ERROR_METADATA_MISSING).error(player); return; } - ItemStack heldBook = InventoryUtil.getHeldBook(player, mainHand); + ItemStack heldBook = InventoryUtil.getHeldBook(player, true); //Only allow the owner to un-sign the book if (BooksWithoutBorders.getConfiguration().getAuthorOnlyUnsign() && @@ -74,7 +75,7 @@ public class CommandUnSign implements TabExecutor { } reverseColorCodes(book); - InventoryUtil.replaceHeldItem(player, book, mainHand); + InventoryUtil.replaceHeldItem(player, book, itemSlot); new FormatBuilder(Translatable.SUCCESS_UNSIGNED).success(player); } diff --git a/src/main/java/net/knarcraft/bookswithoutborders/config/StaticMessage.java b/src/main/java/net/knarcraft/bookswithoutborders/config/StaticMessage.java index d19994e..7a4bb2b 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/config/StaticMessage.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/config/StaticMessage.java @@ -47,6 +47,8 @@ public enum StaticMessage { EXCEPTION_MIGRATE_BOOK_LOAD_FAILED("Unable to load book: {path}"), EXCEPTION_META_HAS_SEPARATOR("The author; {author} or title; {title} contains the title author separator" + " ({separator}). Saving this book would lead to unexpected problems."), + EXCEPTION_GET_HELD_BOOK_INVALID_MATERIAL("Invalid required material specified for method"), + EXCEPTION_ITEM_SLOT_INVALID("Attempting to get item from an invalid item slot"), /** * The cost type used to specify economy diff --git a/src/main/java/net/knarcraft/bookswithoutborders/listener/PlayerEventListener.java b/src/main/java/net/knarcraft/bookswithoutborders/listener/PlayerEventListener.java index 813e55e..af8096d 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/listener/PlayerEventListener.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/listener/PlayerEventListener.java @@ -61,7 +61,7 @@ public class PlayerEventListener implements Listener { if (!bookName.trim().isEmpty()) { //Give the book to the player if it exists - ItemStack newBook = BookLoaderUtil.loadBook(player, bookName, true, BookDirectory.PUBLIC); + ItemStack newBook = BookLoaderUtil.loadBook(player, bookName, true, BookDirectory.PUBLIC, 1); if (newBook != null) { player.getInventory().addItem(newBook); } diff --git a/src/main/java/net/knarcraft/bookswithoutborders/listener/SignEventListener.java b/src/main/java/net/knarcraft/bookswithoutborders/listener/SignEventListener.java index 13d65f0..07d5e13 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/listener/SignEventListener.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/listener/SignEventListener.java @@ -7,6 +7,7 @@ import net.knarcraft.bookswithoutborders.config.translation.SignText; import net.knarcraft.bookswithoutborders.config.translation.Translatable; import net.knarcraft.bookswithoutborders.encryption.EncryptionStyle; import net.knarcraft.bookswithoutborders.state.BookDirectory; +import net.knarcraft.bookswithoutborders.state.ItemSlot; import net.knarcraft.bookswithoutborders.state.SignType; import net.knarcraft.bookswithoutborders.utility.BookFileUtil; import net.knarcraft.bookswithoutborders.utility.BookLoaderUtil; @@ -237,10 +238,9 @@ public class SignEventListener implements Listener { @NotNull EquipmentSlot hand) { ItemStack eBook; String[] lines = sign.getSide(Side.FRONT).getLines(); - boolean mainHand = hand == EquipmentSlot.HAND; if (heldItemType == Material.WRITTEN_BOOK) { player.closeInventory(); - eBook = EncryptedBookUtil.encryptBook(player, mainHand, InputCleaningUtil.stripColor(lines[2]), + eBook = EncryptedBookUtil.encryptBook(player, ItemSlot.fromEquipmentSlot(hand), InputCleaningUtil.stripColor(lines[2]), EncryptionStyle.getFromString(InputCleaningUtil.stripColor(lines[3])), false); if (eBook != null) { player.getInventory().setItem(hand, eBook); @@ -270,7 +270,7 @@ public class SignEventListener implements Listener { fileName += InputCleaningUtil.stripColor(thirdLine); } - ItemStack newBook = BookLoaderUtil.loadBook(player, fileName, true, BookDirectory.PUBLIC); + ItemStack newBook = BookLoaderUtil.loadBook(player, fileName, true, BookDirectory.PUBLIC, 1); if (newBook != null) { player.getInventory().addItem(newBook); diff --git a/src/main/java/net/knarcraft/bookswithoutborders/state/ItemSlot.java b/src/main/java/net/knarcraft/bookswithoutborders/state/ItemSlot.java index 040603e..20bfda4 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/state/ItemSlot.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/state/ItemSlot.java @@ -1,5 +1,8 @@ package net.knarcraft.bookswithoutborders.state; +import org.bukkit.inventory.EquipmentSlot; +import org.jetbrains.annotations.NotNull; + /** * This enum represents the different relevant item slots a target item can exist in */ @@ -18,6 +21,22 @@ public enum ItemSlot { /** * The player does not have the item, or it is ambiguous */ - NONE + NONE, + ; + + /** + * Gets the corresponding item slot from the given equipment slot + * + * @param equipmentSlotThe equipment slot to convert
+ * @returnThe corresponding equipment slot
+ */ + @NotNull + public static ItemSlot fromEquipmentSlot(@NotNull EquipmentSlot equipmentSlot) { + return switch (equipmentSlot) { + case HAND -> ItemSlot.MAIN_HAND; + case OFF_HAND -> ItemSlot.OFF_HAND; + default -> ItemSlot.NONE; + }; + } } diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/BookLoaderUtil.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/BookLoaderUtil.java index c84340d..f8497b5 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/BookLoaderUtil.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/BookLoaderUtil.java @@ -26,21 +26,6 @@ public final class BookLoaderUtil { private BookLoaderUtil() { } - /** - * Loads the given book - * - * @param senderThe command sender trying to load the book
- * @param fileNameThe index or file name of the book to load
- * @param isSignedWhether to load the book as signed, and not unsigned
- * @param directoryThe directory to save the book in
- * @returnThe loaded book
- */ - @Nullable - public static ItemStack loadBook(@NotNull CommandSender sender, @NotNull String fileName, boolean isSigned, - @NotNull BookDirectory directory) { - return loadBook(sender, fileName, isSigned, directory, 1); - } - /** * Loads the given book * @@ -59,7 +44,7 @@ public final class BookLoaderUtil { int bookIndex = Integer.parseInt(fileName); ListThe player encrypting the book
- * @param mainHandWhether the player is holding the book in its main hand
+ * @param itemSlotThe item slot of the held book
* @param keyThe key/password to use for encryption
* @param styleThe encryption style to use
* @param preventAdminDecryptWhether to prevent storage of a key that can be used for admin decryption
* @returnAn encrypted version of the book
*/ @Nullable - public static ItemStack encryptBook(@NotNull Player player, boolean mainHand, @NotNull String key, + public static ItemStack encryptBook(@NotNull Player player, @NotNull ItemSlot itemSlot, @NotNull String key, @NotNull EncryptionStyle style, boolean preventAdminDecrypt) { - return encryptBook(player, mainHand, key, style, "", preventAdminDecrypt); + return encryptBook(player, itemSlot, key, style, "", preventAdminDecrypt); } /** * Encrypts a book * * @param playerThe player encrypting the book
- * @param mainHandWhether the player is holding the book in its main hand
+ * @param itemSlotThe item slot of the held book
* @param keyThe key/password to use for encryption
* @param styleThe encryption style to use
* @param groupNameThe name of the group to encrypt for, or "" otherwise
@@ -112,10 +113,10 @@ public final class EncryptedBookUtil { * @returnAn encrypted version of the book
*/ @Nullable - public static ItemStack encryptBook(Player player, boolean mainHand, @NotNull String key, + public static ItemStack encryptBook(Player player, @NotNull ItemSlot itemSlot, @NotNull String key, @NotNull EncryptionStyle style, @NotNull String groupName, boolean preventAdminDecrypt) { - BookMeta book = InventoryUtil.getHeldBookMetadata(player, mainHand); + BookMeta book = InventoryUtil.getHeldBookMetadata(player, itemSlot); if (book == null) { new FormatBuilder(Translatable.ERROR_METADATA_MISSING).error(player); return null; diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryUtil.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryUtil.java index 60d101e..fe57aab 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryUtil.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryUtil.java @@ -28,9 +28,9 @@ public final class InventoryUtil { */ @Nullable public static ItemStack getHeldBook(@NotNull Player player) { - ItemSlot holdingSlot = InventoryUtil.getHeldSlotBook(player, false, false, false, false); + ItemSlot holdingSlot = InventoryUtil.getHeldBookSlot(player, null); if (holdingSlot != ItemSlot.NONE) { - return InventoryUtil.getHeldItem(player, holdingSlot == ItemSlot.MAIN_HAND); + return InventoryUtil.getHeldItem(player, holdingSlot); } else { return null; } @@ -45,14 +45,11 @@ public final class InventoryUtil { */ @NotNull public static ItemStack getHeldBook(@NotNull Player player, boolean signedBook) { - ItemSlot heldSlot = getHeldSlotBook(player, false, false, true, signedBook); - if (heldSlot == ItemSlot.MAIN_HAND) { - return getHeldItem(player, true); - } else if (heldSlot == ItemSlot.OFF_HAND) { - return getHeldItem(player, false); - } else { + ItemSlot heldSlot = getHeldBookSlot(player, signedBook ? Material.WRITTEN_BOOK : Material.WRITABLE_BOOK); + if (heldSlot == ItemSlot.NONE) { throw new IllegalArgumentException(StaticMessage.EXCEPTION_NOT_HOLDING_ONE_BOOK.toString()); } + return getHeldItem(player, heldSlot); } /** @@ -62,11 +59,11 @@ public final class InventoryUtil { * @param newBookThe new book the player should hold
*/ public static void setHeldWrittenBook(@NotNull Player player, @NotNull ItemStack newBook) { - ItemSlot itemSlot = getHeldSlotBook(player, false, false, true, true); + ItemSlot itemSlot = getHeldBookSlot(player, Material.WRITTEN_BOOK); if (itemSlot == ItemSlot.MAIN_HAND) { - replaceHeldItem(player, newBook, true); + replaceHeldItem(player, newBook, itemSlot); } else if (itemSlot == ItemSlot.OFF_HAND) { - replaceHeldItem(player, newBook, false); + replaceHeldItem(player, newBook, itemSlot); } else { new FormatBuilder(Translatable.ERROR_BOOK_NOT_FOUND).error(player); } @@ -124,66 +121,117 @@ public final class InventoryUtil { return false; } + /** + * Gets metadata about the player's held book + * + * @param playerThe player holding the book
+ * @param itemSlotThe item slot of the item to get metadata about
+ * @returnInformation about the held book
+ */ + @Nullable + public static BookMeta getHeldBookMetadata(@NotNull Player player, @NotNull ItemSlot itemSlot) { + return (BookMeta) getHeldItem(player, itemSlot).getItemMeta(); + } + + /** + * Gets the item the player is holding + * + * @param playerThe player to get from
+ * @param itemSlotThe item slot of the item to get
+ * @returnThe item the player is holding in the given hand
+ */ + @NotNull + public static ItemStack getHeldItem(@NotNull Player player, @NotNull ItemSlot itemSlot) { + return switch (itemSlot) { + case MAIN_HAND -> player.getInventory().getItemInMainHand(); + case OFF_HAND -> player.getInventory().getItemInOffHand(); + case NONE -> throw new IllegalArgumentException(StaticMessage.EXCEPTION_ITEM_SLOT_INVALID.toString()); + }; + } + + /** + * Replaces the player's held item + * + * @param playerThe player to replace the item for
+ * @param newBookThe new book the player should hold
+ * @param itemSlotThe item slot of the item to replace
+ */ + public static void replaceHeldItem(@NotNull Player player, @NotNull ItemStack newBook, @NotNull ItemSlot itemSlot) { + if (itemSlot == ItemSlot.MAIN_HAND) { + player.getInventory().setItemInMainHand(newBook); + } else if (itemSlot == ItemSlot.OFF_HAND) { + player.getInventory().setItemInOffHand(newBook); + } else { + throw new IllegalArgumentException(StaticMessage.EXCEPTION_ITEM_SLOT_INVALID.toString()); + } + } + /** * Gets the slot of the player's held book * - * @param playerThe player holding the book
- * @param handMattersWhether the differentiation between the main hand and the off hand is relevant
- * @param mainHandWhether to search the player's main hand or off hand, if it's relevant
- * @param typeMattersWhether the differentiation between signed and unsigned books is relevant
- * @param writtenBookWhether to search for written or unwritten books, if it's relevant
+ * @param playerThe player holding the book
+ * @param requiredMaterialThe required material of the book to look for. Set to null if it doesn't matter
* @returnThe slot of the player's held book
*/ @NotNull - public static ItemSlot getHeldSlotBook(@NotNull Player player, boolean handMatters, boolean mainHand, - boolean typeMatters, boolean writtenBook) { + public static ItemSlot getHeldBookSlot(@NotNull Player player, @Nullable Material requiredMaterial) { BookHoldingState state = getBookHoldingState(player); - ItemStack mainHandItem = getHeldItem(player, true); - ItemStack offHandItem = getHeldItem(player, false); - Material requiredMaterial = writtenBook ? Material.WRITTEN_BOOK : Material.WRITABLE_BOOK; - //Ambiguous or empty - if (state == BookHoldingState.SIGNED_BOTH_HANDS || - state == BookHoldingState.UNSIGNED_BOTH_HANDS || - state == BookHoldingState.NONE) { - return ItemSlot.NONE; - } - if (handMatters && typeMatters) { - if (mainHand && mainHandItem.getType() == requiredMaterial) { - return ItemSlot.MAIN_HAND; - } else if (!mainHand && offHandItem.getType() == requiredMaterial) { - return ItemSlot.OFF_HAND; - } - } else if (handMatters) { - //Ambiguous - if (state == BookHoldingState.SIGNED_MAIN_HAND_UNSIGNED_OFF_HAND || - state == BookHoldingState.UNSIGNED_MAIN_HAND_SIGNED_OFF_HAND) { - return ItemSlot.NONE; - } - if (mainHand) { - return ItemSlot.MAIN_HAND; - } else { - return ItemSlot.OFF_HAND; - } - } else if (typeMatters) { - if ((writtenBook && (state == BookHoldingState.SIGNED_MAIN_HAND || - state == BookHoldingState.SIGNED_MAIN_HAND_UNSIGNED_OFF_HAND)) || (!writtenBook && - (state == BookHoldingState.UNSIGNED_MAIN_HAND || - state == BookHoldingState.UNSIGNED_MAIN_HAND_SIGNED_OFF_HAND))) { - return ItemSlot.MAIN_HAND; - } else if ((writtenBook && (state == BookHoldingState.SIGNED_OFF_HAND || - state == BookHoldingState.UNSIGNED_MAIN_HAND_SIGNED_OFF_HAND)) || (!writtenBook && ( - state == BookHoldingState.UNSIGNED_OFF_HAND) || - state == BookHoldingState.SIGNED_MAIN_HAND_UNSIGNED_OFF_HAND)) { - return ItemSlot.OFF_HAND; - } + + if (requiredMaterial != null) { + return switch (requiredMaterial) { + case WRITTEN_BOOK -> getSignedBookSlot(state); + case WRITABLE_BOOK -> getUnsignedBookSlot(state); + default -> + throw new IllegalArgumentException(StaticMessage.EXCEPTION_GET_HELD_BOOK_INVALID_MATERIAL.toString()); + }; } else { - if (state == BookHoldingState.SIGNED_MAIN_HAND || state == BookHoldingState.UNSIGNED_MAIN_HAND) { - return ItemSlot.MAIN_HAND; - } else if (state == BookHoldingState.SIGNED_OFF_HAND || state == BookHoldingState.UNSIGNED_OFF_HAND) { - return ItemSlot.OFF_HAND; - } + return getBookSlot(state); } - return ItemSlot.NONE; + } + + /** + * Gets the slot of the held book + * + * @param bookHoldingStateThe book holding state to check
+ * @returnThe item slot of the held book
+ */ + @NotNull + private static ItemSlot getBookSlot(@NotNull BookHoldingState bookHoldingState) { + return switch (bookHoldingState) { + case SIGNED_MAIN_HAND, UNSIGNED_MAIN_HAND -> ItemSlot.MAIN_HAND; + case SIGNED_OFF_HAND, UNSIGNED_OFF_HAND -> ItemSlot.OFF_HAND; + default -> ItemSlot.NONE; + }; + } + + /** + * Gets the slot of the held signed book + * + * @param bookHoldingStateThe book holding state to check
+ * @returnThe item slot of the held signed book
+ */ + @NotNull + private static ItemSlot getSignedBookSlot(@NotNull BookHoldingState bookHoldingState) { + return switch (bookHoldingState) { + case SIGNED_MAIN_HAND, SIGNED_MAIN_HAND_UNSIGNED_OFF_HAND -> ItemSlot.MAIN_HAND; + case SIGNED_OFF_HAND, UNSIGNED_MAIN_HAND_SIGNED_OFF_HAND -> ItemSlot.OFF_HAND; + default -> ItemSlot.NONE; + }; + } + + /** + * Gets the slot of the held unsigned book + * + * @param bookHoldingStateThe book holding state to check
+ * @returnThe item slot of the held unsigned book
+ */ + @NotNull + private static ItemSlot getUnsignedBookSlot(@NotNull BookHoldingState bookHoldingState) { + return switch (bookHoldingState) { + case UNSIGNED_MAIN_HAND, UNSIGNED_MAIN_HAND_SIGNED_OFF_HAND -> ItemSlot.MAIN_HAND; + case UNSIGNED_OFF_HAND, SIGNED_MAIN_HAND_UNSIGNED_OFF_HAND -> ItemSlot.OFF_HAND; + default -> ItemSlot.NONE; + }; } /** @@ -194,8 +242,8 @@ public final class InventoryUtil { */ @NotNull private static BookHoldingState getBookHoldingState(@NotNull Player player) { - ItemStack mainHandItem = getHeldItem(player, true); - ItemStack offHandItem = getHeldItem(player, false); + ItemStack mainHandItem = getHeldItem(player, ItemSlot.MAIN_HAND); + ItemStack offHandItem = getHeldItem(player, ItemSlot.OFF_HAND); boolean hasSignedBookInMainHand = mainHandItem.getType() == Material.WRITTEN_BOOK; boolean hasUnsignedBookInMainHand = mainHandItem.getType() == Material.WRITABLE_BOOK; @@ -223,47 +271,4 @@ public final class InventoryUtil { } } - /** - * Gets metadata about the player's held book - * - * @param playerThe player holding the book
- * @param mainHandWhether to get information about a book in the player's main hand or off hand
- * @returnInformation about the held book
- */ - @Nullable - public static BookMeta getHeldBookMetadata(@NotNull Player player, boolean mainHand) { - return (BookMeta) getHeldItem(player, mainHand).getItemMeta(); - } - - /** - * Gets the item the player is holding - * - * @param playerThe player to get from
- * @param mainHandWhether to get the item in the player's main hand or off hand
- * @returnThe item the player is holding in the given hand
- */ - @NotNull - public static ItemStack getHeldItem(@NotNull Player player, boolean mainHand) { - if (mainHand) { - return player.getInventory().getItemInMainHand(); - } else { - return player.getInventory().getItemInOffHand(); - } - } - - /** - * Replaces the player's held item - * - * @param playerThe player to replace the item for
- * @param newBookThe new book the player should hold
- * @param mainHandWhether to replace the item in the player's main hand or off hand
- */ - public static void replaceHeldItem(@NotNull Player player, @NotNull ItemStack newBook, boolean mainHand) { - if (mainHand) { - player.getInventory().setItemInMainHand(newBook); - } else { - player.getInventory().setItemInOffHand(newBook); - } - } - }