ClickInformation.java

/*
 * Copyright (C) Matthew Steglinski (SainttX) <matt@ipvp.org>
 * Copyright (C) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.ipvp.canvas;

import java.util.Objects;

import org.bukkit.entity.Player;
import org.bukkit.event.Event;
import org.bukkit.event.inventory.*;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemStack;
import org.ipvp.canvas.slot.Slot;

/**
 * Information about a click performed by a player in a Menu
 */
public class ClickInformation {

    private final InventoryInteractEvent handle;
    private final InventoryAction inventoryAction;
    private final ClickType clickType;
    private final Inventory clicked;
    private final Menu clickedMenu;
    private final Slot clickedSlot;
    private final ItemStack addingItem;
    private Event.Result result;

    ClickInformation(InventoryInteractEvent handle, InventoryAction inventoryAction, ClickType clickType,
                     Inventory clicked, Menu clickedMenu, Slot clickedSlot, Event.Result result) {
        this(handle, inventoryAction, clickType, clicked, clickedMenu, clickedSlot, result, null);
    }

    ClickInformation(InventoryInteractEvent handle, InventoryAction inventoryAction, ClickType clickType,
                     Inventory clicked, Menu clickedMenu, Slot clickedSlot, Event.Result result, ItemStack addingItem) {
        this.handle = handle;
        this.inventoryAction = inventoryAction;
        this.clickType = clickType;
        this.clicked = clicked;
        this.clickedMenu = clickedMenu;
        this.clickedSlot = clickedSlot;
        this.result = result;
        this.addingItem = addingItem;
    }

    /**
     * Returns the Menu that is handling the click
     *
     * @return The handling Menu
     */
    public Menu getClickedMenu() {
        return clickedMenu;
    }

    /**
     * Returns the Slot that was clicked
     *
     * @return The clicked Slot
     */
    public Slot getClickedSlot() {
        return clickedSlot;
    }

    /**
     * Returns the action performed by a player
     *
     * @return The action of a player
     */
    public InventoryAction getAction() {
        return inventoryAction;
    }

    /**
     * Returns the type of click performed by a player
     *
     * @return The type of click
     */
    public ClickType getClickType() {
        return clickType;
    }

    /**
     * Returns the result that the click will have in the inventory
     *
     * @return The click result
     */
    public Event.Result getResult() {
        return result;
    }

    /**
     * Sets the result that the click will have in the inventory
     *
     * @param result The new result
     */
    public void setResult(Event.Result result) {
        Objects.requireNonNull(result);
        this.result = result;
    }

    /**
     * @return Whether the Player is adding an item into the slot
     */
    public boolean isAddingItem() {
        switch (getAction()) {
            case PLACE_ALL:
            case PLACE_SOME:
            case PLACE_ONE:
            case SWAP_WITH_CURSOR:
            case HOTBAR_SWAP:
                return true;
            case MOVE_TO_OTHER_INVENTORY:
                return handle.getView().getBottomInventory() == clicked;
            default:
                return false;
        }
    }

    /**
     * Returns the item that is being added into the clicked slot
     *
     * @return Item being added
     * @throws IllegalStateException If {@link #isAddingItem()} is false
     */
    public ItemStack getAddingItem() {
       if (!isAddingItem()) {
           throw new IllegalStateException("Not adding item");
       } else if (addingItem != null) {
           return new ItemStack(addingItem);
       } else if (handle instanceof InventoryDragEvent) {
           InventoryDragEvent event = (InventoryDragEvent) handle;
           return event.getNewItems().get(clickedSlot.getIndex());
       } else {
           InventoryClickEvent clickEvent = ((InventoryClickEvent) handle);
           switch (clickEvent.getAction()) {
               case HOTBAR_SWAP:
                   int hotbarSlot = clickEvent.getHotbarButton();
                   return clickEvent.getView().getBottomInventory().getItem(hotbarSlot);
               case MOVE_TO_OTHER_INVENTORY:
                   return clickEvent.getCurrentItem();
               default:
                   return clickEvent.getCursor();
           }
       }
    }

    /**
     * Returns the amount of items being added into the slot.
     *
     * @return added item amount
     */
    public int getAddingItemAmount() {
        if (!isAddingItem()) {
            return -1;
        }
        switch (getAction()) {
            case PLACE_ONE:
                return 1;
            case PLACE_SOME:
                ItemStack current = getRawItem();
                int limit = current == null ? 64 : current.getType().getMaxStackSize();
                return Math.min(limit, getAddingItem().getAmount());
            case PLACE_ALL:
            case MOVE_TO_OTHER_INVENTORY:
            case SWAP_WITH_CURSOR:
            case HOTBAR_SWAP:
                return getAddingItem().getAmount();
            default:
                return -1;
        }
    }

    /**
     * @return Whether the Player is removing an item from the slot
     */
    public boolean isTakingItem() {
        switch (getAction()) {
            case PICKUP_ALL:
            case PICKUP_HALF:
            case PICKUP_ONE:
            case PICKUP_SOME:
            case SWAP_WITH_CURSOR:
                return true;
            case MOVE_TO_OTHER_INVENTORY:
            case HOTBAR_SWAP:
                return handle.getView().getTopInventory() == clicked;
            default:
                return isDroppingItem();
        }
    }

    /**
     * Returns the item that is being added into the clicked slot
     *
     * @return Item being added
     * @throws IllegalStateException If {@link #isAddingItem()} is false
     */
    public ItemStack getTakingItem() {
        if (!isTakingItem()) {
            throw new IllegalStateException("An item is not being taken");
        } else {
            InventoryClickEvent clickEvent = ((InventoryClickEvent) handle);
            return clickEvent.getCurrentItem();
        }
    }

    /**
     * Returns the amount of items being added into the slot.
     *
     * @return added item amount
     */
    public int getTakingItemAmount() {
        if (!isTakingItem()) {
            return -1;
        }
        switch (getAction()) {
            case PICKUP_ONE:
            case DROP_ONE_SLOT:
                return 1;
            case PICKUP_HALF:
                return (int) Math.ceil(getRawItem().getAmount() / 2D);
            case PICKUP_SOME:
                // This case seems to occur when a stack being picked up exceeds the max size,
                // and so only the max stack is placed onto the cursor.
                // ref: https://www.spigotmc.org/threads/what-is-inventoryaction-pickup_some.485557/#post-4064128
                return getRawItem().getMaxStackSize();
            case PICKUP_ALL:
            case DROP_ALL_SLOT:
            case MOVE_TO_OTHER_INVENTORY:
            case SWAP_WITH_CURSOR:
            case HOTBAR_SWAP:
                return getRawItem().getAmount();
            default:
                return -1;
        }
    }

    /**
     * @return the amount of items being added or removed.
     * @deprecated superseded by {@link #getAddingItemAmount()} and {@link #getTakingItemAmount()}
     */
    @Deprecated
    public int getItemAmount() {
        switch (getAction()) {
            case PLACE_ALL:
                return getAddingItem().getAmount();
            case PLACE_SOME:
                ItemStack current = getRawItem();
                int limit = current == null ? 64 : current.getType().getMaxStackSize();
                return Math.min(limit, getAddingItem().getAmount());
            case PLACE_ONE:
            case PICKUP_ONE:
            case DROP_ONE_SLOT:
                return 1;
            case PICKUP_HALF:
                return (int) Math.ceil(getRawItem().getAmount() / 2D);
            case PICKUP_ALL:
            case DROP_ALL_SLOT:
                return getRawItem().getAmount();
            case MOVE_TO_OTHER_INVENTORY:
                return isAddingItem() ? getAddingItem().getAmount()
                        : getRawItem().getAmount();
            case PICKUP_SOME: // Don't know how this is caused
            case SWAP_WITH_CURSOR:
            default:
                throw new UnsupportedOperationException();
        }
    }

    private ItemStack getRawItem() {
        return getClickedSlot().getRawItem((Player) handle.getWhoClicked());
    }

    /**
     * @return Whether the Player is dropping the item in the slot
     */
    public boolean isDroppingItem() {
        switch (getAction()) {
            case DROP_ALL_SLOT:
            case DROP_ONE_SLOT:
                return true;
            default:
                return false;
        }
    }
}