org.bukkit.event.inventory.InventoryClickEvent Maven / Gradle / Ivy
Show all versions of walk-server Show documentation
package org.bukkit.event.inventory;
import org.bukkit.Location;
import org.bukkit.entity.HumanEntity;
import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
import org.bukkit.event.inventory.InventoryType.SlotType;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.InventoryView;
import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.Plugin;
import org.bukkit.scheduler.BukkitScheduler;
/**
* This event is called when a player clicks a slot in an inventory.
*
* Because InventoryClickEvent occurs within a modification of the Inventory,
* not all Inventory related methods are safe to use.
*
* The following should never be invoked by an EventHandler for
* InventoryClickEvent using the HumanEntity or InventoryView associated with
* this event:
*
* - {@link HumanEntity#closeInventory()}
*
- {@link HumanEntity#openInventory(Inventory)}
*
- {@link HumanEntity#openWorkbench(Location, boolean)}
*
- {@link HumanEntity#openEnchanting(Location, boolean)}
*
- {@link InventoryView#close()}
*
* To invoke one of these methods, schedule a task using
* {@link BukkitScheduler#runTask(Plugin, Runnable)}, which will run the task
* on the next tick. Also be aware that this is not an exhaustive list, and
* other methods could potentially create issues as well.
*
* Assuming the EntityHuman associated with this event is an instance of a
* Player, manipulating the MaxStackSize or contents of an Inventory will
* require an Invocation of {@link Player#updateInventory()}.
*
* Modifications to slots that are modified by the results of this
* InventoryClickEvent can be overwritten. To change these slots, this event
* should be cancelled and all desired changes to the inventory applied.
* Alternatively, scheduling a task using {@link BukkitScheduler#runTask(
*Plugin, Runnable)}, which would execute the task on the next tick, would
* work as well.
*/
public class InventoryClickEvent extends InventoryInteractEvent {
private static final HandlerList handlers = new HandlerList();
private final ClickType click;
private final InventoryAction action;
private final Inventory clickedInventory;
private final SlotType slot_type;
private final int whichSlot;
private final int rawSlot;
private ItemStack current = null;
private int hotbarKey = -1;
@Deprecated
public InventoryClickEvent(InventoryView view, SlotType type, int slot, boolean right, boolean shift) {
this(view, type, slot, right ? (shift ? ClickType.SHIFT_RIGHT : ClickType.RIGHT) : (shift ? ClickType.SHIFT_LEFT : ClickType.LEFT), InventoryAction.SWAP_WITH_CURSOR);
}
public InventoryClickEvent(InventoryView view, SlotType type, int slot, ClickType click, InventoryAction action) {
super(view);
this.slot_type = type;
this.rawSlot = slot;
if (slot < 0) {
this.clickedInventory = null;
} else if (view.getTopInventory() != null && slot < view.getTopInventory().getSize()) {
this.clickedInventory = view.getTopInventory();
} else {
this.clickedInventory = view.getBottomInventory();
}
this.whichSlot = view.convertSlot(slot);
this.click = click;
this.action = action;
}
public InventoryClickEvent(InventoryView view, SlotType type, int slot, ClickType click, InventoryAction action, int key) {
this(view, type, slot, click, action);
this.hotbarKey = key;
}
public static HandlerList getHandlerList() {
return handlers;
}
/**
* Gets the inventory that was clicked, or null if outside of window
*
* @return The clicked inventory
*/
public Inventory getClickedInventory() {
return clickedInventory;
}
/**
* Gets the type of slot that was clicked.
*
* @return the slot type
*/
public SlotType getSlotType() {
return slot_type;
}
/**
* Gets the current ItemStack on the cursor.
*
* @return the cursor ItemStack
*/
public ItemStack getCursor() {
return getView().getCursor();
}
/**
* Sets the item on the cursor.
*
* @param stack the new cursor item
*/
public void setCursor(ItemStack stack) {
getView().setCursor(stack);
}
/**
* Gets the ItemStack currently in the clicked slot.
*
* @return the item in the clicked
*/
public ItemStack getCurrentItem() {
if (slot_type == SlotType.OUTSIDE) {
return current;
}
return getView().getItem(rawSlot);
}
/**
* Sets the ItemStack currently in the clicked slot.
*
* @param stack the item to be placed in the current slot
*/
public void setCurrentItem(ItemStack stack) {
if (slot_type == SlotType.OUTSIDE) {
current = stack;
} else {
getView().setItem(rawSlot, stack);
}
}
/**
* Gets whether or not the ClickType for this event represents a right
* click.
*
* @return true if the ClickType uses the right mouse button.
* @see ClickType#isRightClick()
*/
public boolean isRightClick() {
return click.isRightClick();
}
/**
* Gets whether or not the ClickType for this event represents a left
* click.
*
* @return true if the ClickType uses the left mouse button.
* @see ClickType#isLeftClick()
*/
public boolean isLeftClick() {
return click.isLeftClick();
}
/**
* Gets whether the ClickType for this event indicates that the key was
* pressed down when the click was made.
*
* @return true if the ClickType uses Shift or Ctrl.
* @see ClickType#isShiftClick()
*/
public boolean isShiftClick() {
return click.isShiftClick();
}
/**
* The slot number that was clicked, ready for passing to
* {@link Inventory#getItem(int)}. Note that there may be two slots with
* the same slot number, since a view links two different inventories.
*
* @return The slot number.
*/
public int getSlot() {
return whichSlot;
}
/**
* The raw slot number clicked, ready for passing to {@link InventoryView
* #getItem(int)} This slot number is unique for the view.
*
* @return the slot number
*/
public int getRawSlot() {
return rawSlot;
}
/**
* If the ClickType is NUMBER_KEY, this method will return the index of
* the pressed key (0-8).
*
* @return the number on the key minus 1 (range 0-8); or -1 if not
* a NUMBER_KEY action
*/
public int getHotbarButton() {
return hotbarKey;
}
/**
* Gets the InventoryAction that triggered this event.
*
* This action cannot be changed, and represents what the normal outcome
* of the event will be. To change the behavior of this
* InventoryClickEvent, changes must be manually applied.
*
* @return the InventoryAction that triggered this event.
*/
public InventoryAction getAction() {
return action;
}
/**
* Gets the ClickType for this event.
*
* This is insulated against changes to the inventory by other plugins.
*
* @return the type of inventory click
*/
public ClickType getClick() {
return click;
}
@Override
public HandlerList getHandlers() {
return handlers;
}
}