net.minestom.server.item.StackingRule Maven / Gradle / Ivy

Go to download
package net.minestom.server.item;

import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;

import java.util.function.IntUnaryOperator;

/**
 * Represents the stacking rule of an {@link ItemStack}.
 * This can be used to mimic the vanilla one (using the displayed item quantity)
 * or a complete new one which can be stored in lore, name, etc...
 */
public interface StackingRule {

    static @NotNull StackingRule get() {
        return ItemStackImpl.DEFAULT_STACKING_RULE;
    }

    /**
     * Used to know if two {@link ItemStack} can be stacked together.
     *
     * @param item1 the first {@link ItemStack}
     * @param item2 the second {@link ItemStack}
     * @return true if both {@link ItemStack} can be stacked together
     * (without taking their amount in consideration)
     */
    boolean canBeStacked(@NotNull ItemStack item1, @NotNull ItemStack item2);

    /**
     * Used to know if an {@link ItemStack} can have the size {@code newAmount} applied.
     *
     * @param item   the {@link ItemStack} to check
     * @param amount the desired new amount
     * @return true if {@code item} can have its stack size set to newAmount
     */
    boolean canApply(@NotNull ItemStack item, int amount);

    /**
     * Changes the size of the {@link ItemStack} to {@code newAmount}.
     * At this point we know that the item can have this stack size applied.
     *
     * @param item      the {@link ItemStack} to applies the size to
     * @param newAmount the new item size
     * @return a new {@link ItemStack item} with the specified amount
     */
    @Contract("_, _ -> new")
    @NotNull ItemStack apply(@NotNull ItemStack item, int newAmount);

    @Contract("_, _ -> new")
    default @NotNull ItemStack apply(@NotNull ItemStack item, @NotNull IntUnaryOperator amountOperator) {
        return apply(item, amountOperator.applyAsInt(getAmount(item)));
    }

    /**
     * Used to determine the current stack size of an {@link ItemStack}.
     * It is possible to have it stored in its nbt.
     *
     * @param itemStack the {@link ItemStack} to check the size
     * @return the correct size of {@link ItemStack}
     */
    int getAmount(@NotNull ItemStack itemStack);

    /**
     * Gets the max size of a stack.
     *
     * @param itemStack the item to get the max size from
     * @return the max size of a stack
     */
    int getMaxSize(@NotNull ItemStack itemStack);
}