Skip to content

fix: preserve skinned books edited in the off-hand #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
XxFran10xX merged 2 commits into from
Sep 26, 2026
Merged

fix: preserve skinned books edited in the off-hand #29

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
175382b
fix: preserve skinned books edited in the off-hand
XxFran10xX Sep 26, 2026
284d81d
fix: map off-hand slot when signing skinned books
XxFran10xX Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/main/java/net/tfminecraft/armourshop/managers/BookEditSkinPreserver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.PlayerInventory;
import org.bukkit.inventory.meta.BookMeta;
import org.bukkit.inventory.meta.ItemMeta;

/** Keep the original custom item intact while accepting the final edited pages. */
public final class BookEditSkinPreserver {
private static final int OFF_HAND_SLOT = 40;

private final Predicate<ItemStack> isCustomBook;

public BookEditSkinPreserver(Predicate<ItemStack> isCustomBook) {
Expand All @@ -19,7 +22,16 @@ public BookEditSkinPreserver(Predicate<ItemStack> isCustomBook) {

// Called by ArmourShop's existing MONITOR listener, registered after ItemsAdder.
public static void preserve(PlayerEditBookEvent event) {
new BookEditSkinPreserver(item -> CustomStack.byItemStack(item) != null).onEditBook(event);
new BookEditSkinPreserver(BookEditSkinPreserver::isCustomBook).onEditBook(event);
}

// Letters and other skinned books carry a model without always being an IA item.
// Keep the legacy custom model data check that skinned books were written with.
@SuppressWarnings("deprecation")
static boolean isCustomBook(ItemStack item) {
ItemMeta meta = item.getItemMeta();
return meta != null && (meta.hasCustomModelData() || meta.hasItemModel())
|| CustomStack.byItemStack(item) != null;
}

// Retain the originating book slot for deferred restoration; this API exposes no replacement.
Expand All @@ -29,6 +41,8 @@ public void onEditBook(PlayerEditBookEvent event) {
if (event.isCancelled() || event.isSigning()) return;
PlayerInventory inventory = event.getPlayer().getInventory();
int slot = event.getSlot();
// Paper reports off-hand edits as -1.
if (slot == -1) slot = OFF_HAND_SLOT;
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
if (slot < 0 || slot >= inventory.getSize()) return;
ItemStack item = inventory.getItem(slot);
if (item == null || item.getType() != Material.WRITABLE_BOOK || !isCustomBook.test(item)) return;
Expand Down
27 changes: 26 additions & 1 deletion src/test/java/net/tfminecraft/armourshop/managers/BookEditSkinPreserverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.PlayerInventory;
import org.bukkit.inventory.meta.BookMeta;
import org.bukkit.inventory.meta.ItemMeta;
import org.junit.jupiter.api.Test;

class BookEditSkinPreserverTest {
Expand Down Expand Up @@ -75,13 +76,37 @@ private void slot(int slot) {
slot(0);
new BookEditSkinPreserver(stack -> false).onEditBook(event);
verify(event, never()).setNewBookMeta(any());
when(event.getSlot()).thenReturn(-1);
when(event.getSlot()).thenReturn(-2);
new BookEditSkinPreserver(stack -> true).onEditBook(event);
when(event.getSlot()).thenReturn(41);
new BookEditSkinPreserver(stack -> true).onEditBook(event);
verify(event, never()).getPreviousBookMeta();
}

// Retain the originating book slot for deferred restoration; this API exposes no replacement.
@SuppressWarnings({"deprecation", "removal"})
@Test void readsOffHandBookWhenPaperReportsMinusOne() {
slot(40);
when(event.getSlot()).thenReturn(-1);
new BookEditSkinPreserver(stack -> false).onEditBook(event);
verify(inventory).getItem(40);
verify(inventory, never()).getItem(-1);
}

// Legacy custom model data is how existing skinned books are identified.
@SuppressWarnings("deprecation")
@Test void treatsModelledBooksAsCustom() {
ItemMeta withModelData = mock(ItemMeta.class);
when(withModelData.hasCustomModelData()).thenReturn(true);
when(item.getItemMeta()).thenReturn(withModelData);
assertTrue(BookEditSkinPreserver.isCustomBook(item));

ItemMeta withItemModel = mock(ItemMeta.class);
when(withItemModel.hasItemModel()).thenReturn(true);
when(item.getItemMeta()).thenReturn(withItemModel);
assertTrue(BookEditSkinPreserver.isCustomBook(item));
}

@Test void skipsEmptySlotsAndNonBooks() {
slot(0);
when(inventory.getItem(0)).thenReturn(null);
Expand Down