com.github.ms5984.api.menuman

Class MenuClick

java.lang.Object

com.github.ms5984.api.menuman.MenuClick

public final class MenuClick
extends Object

Class which encapsulates relevant data of InventoryClickEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MenuClick.InventorySlot An encapsulation of inventory slot interactions.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.bukkit.entity.Player	player The player who clicked the Menu.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MenuClick(org.bukkit.event.inventory.InventoryClickEvent e, org.bukkit.entity.Player player) Create a MenuClick to pass to a MenuAction.

Method Summary

Modifier and Type	Method and Description
void	allowClick() Uncancel the event and allow the click to follow through.
void	disallowClick() Cancel the click event, preventing pickup of the item.
org.bukkit.event.inventory.ClickType	getClickType() Get the ClickType of this event.
org.bukkit.inventory.InventoryView	getInventoryView() Get the full InventoryView of the transaction.
Optional<org.bukkit.inventory.ItemStack>	getItemOnMouseCursor() Check for the item currently on the cursor.
org.bukkit.entity.Player	getPlayer() Get the player that clicked the Menu.
Optional<MenuClick.InventorySlot>	getSlotClicked() Get an Optional describing the slot clicked, if applicable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

player

protected final org.bukkit.entity.Player player

The player who clicked the Menu.

Constructor Detail

MenuClick

protected MenuClick(org.bukkit.event.inventory.InventoryClickEvent e,
                    org.bukkit.entity.Player player)

Create a MenuClick to pass to a MenuAction.

Parameters:

e - original event

player - a player

Method Detail

getPlayer

public org.bukkit.entity.Player getPlayer()

Get the player that clicked the Menu.

Returns:

player

getInventoryView

public org.bukkit.inventory.InventoryView getInventoryView()

Get the full InventoryView of the transaction.

Returns:

the InventoryView for the transaction

getClickType

public org.bukkit.event.inventory.ClickType getClickType()

Get the ClickType of this event.

Feel free to explore the enum, it looks powerful.

Returns:

InventoryClickEvent.getClick()

getSlotClicked

public Optional<MenuClick.InventorySlot> getSlotClicked()

Get an Optional describing the slot clicked, if applicable.

Returns:

an Optional of the clicked InventorySlot

getItemOnMouseCursor

public Optional<org.bukkit.inventory.ItemStack> getItemOnMouseCursor()

Check for the item currently on the cursor.

This is usually null, so instead of using the Nullable annotation here I chose to use Optional.ofNullable(T).

Returns:

an Optional describing an ItemStack or an empty Optional

allowClick

public void allowClick()

Uncancel the event and allow the click to follow through.

disallowClick

public void disallowClick()

Cancel the click event, preventing pickup of the item.