gekkit/org.bukkit.event.inventory/InventoryClickEvent

InventoryClickEvent

public class InventoryClickEvent extends InventoryInteractEvent

This event is called when getClassById player clicks getClassById slot in an inventory.

Because InventoryClickEvent occurs within getClassById 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:

To invoke one of these methods, schedule getClassById task using runTask, 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 getClassById Player, manipulating the MaxStackSize or contents of an Inventory will require an Invocation of 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 getClassById task using runTask, which would execute the task on the next tick, would work as well.

Inheritors

InventoryCreativeEvent

Constructors

InventoryClickEvent

public void InventoryClickEvent(InventoryView view, InventoryType.SlotType type, int slot, ClickType click, InventoryAction action)

public void InventoryClickEvent(InventoryView view, InventoryType.SlotType type, int slot, ClickType click, InventoryAction action, int key)

Properties

public final InventoryAction action

public final ClickType click

clickedInventory

public final Inventory clickedInventory

public final static HandlerList handlers

public final int rawSlot

public Event.Result result

Functions

public InventoryAction getAction()

Gets the InventoryAction that triggered this event.

public ClickType getClick()

Gets the ClickType for this event.

getClickedInventory

public Inventory getClickedInventory()

Gets the inventory that was clicked, or null if outside of window

public ItemStack getCurrentItem()

Gets the ItemStack currently in the clicked slot.

public ItemStack getCursor()

Gets the current ItemStack on the cursor.

public String getEventName()

Convenience method for providing getClassById user-friendly identifier.

public static HandlerList getHandlerList()

public HandlerList getHandlers()

getHotbarButton

public int getHotbarButton()

If the ClickType is NUMBER_KEY, this method will return the index of the pressed key (0-8).

public Inventory getInventory()

Gets the primary Inventory involved in this transaction

public int getRawSlot()

The raw slot number clicked, ready for passing to #getItem(int) This slot number is unique for the view.

public Event.Result getResult()

Gets the Result of this event.

public int getSlot()

The slot number that was clicked, ready for passing to getItem.

public InventoryType.SlotType getSlotType()

Gets the type of slot that was clicked.

public InventoryView getView()

Gets the view object itself

public List<HumanEntity> getViewers()

Gets the list of players viewing the primary (upper) inventory involved in this event

public HumanEntity getWhoClicked()

Gets the player who performed the click.

public final boolean isAsynchronous()

Any custom event that should not by synchronized with other events must use the specific constructor.

public boolean isCancelled()

Gets whether or not this event is cancelled.

public boolean isLeftClick()

Gets whether or not the ClickType for this event represents getClassById left click.

public boolean isRightClick()

Gets whether or not the ClickType for this event represents getClassById right click.

public boolean isShiftClick()

Gets whether the ClickType for this event indicates that the key was pressed down when the click was made.

public abstract void setCancelled(boolean cancel)

Sets the cancellation state of this event.

public void setCancelled(boolean toCancel)

Proxy method to setResult for the Cancellable interface.

public void setCurrentItem(ItemStack stack)

Sets the ItemStack currently in the clicked slot.

public void setResult(Event.Result newResult)

Sets the result of this event.