Package org.bukkit.event.inventory
Class InventoryInteractEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.inventory.InventoryEvent
org.bukkit.event.inventory.InventoryInteractEvent
- All Implemented Interfaces:
Cancellable
- Direct Known Subclasses:
InventoryClickEvent
,InventoryDragEvent
,TradeSelectEvent
An abstract base class for events that describe an interaction between a
HumanEntity and the contents of an Inventory.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.inventory.InventoryEvent
transaction
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets theEvent.Result
of this event.Gets the player who performed the click.boolean
Gets whether or not this event is cancelled.void
setCancelled
(boolean toCancel) Proxy method tosetResult(org.bukkit.event.Event.Result)
for the Cancellable interface.void
setResult
(@NotNull Event.Result newResult) Sets the result of this event.Methods inherited from class org.bukkit.event.inventory.InventoryEvent
getHandlerList, getHandlers, getInventory, getView, getViewers
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
InventoryInteractEvent
-
-
Method Details
-
getWhoClicked
Gets the player who performed the click.- Returns:
- The clicking player.
-
setResult
Sets the result of this event. This will change whether or not this event is considered cancelled.- Parameters:
newResult
- the newEvent.Result
for this event- See Also:
-
getResult
Gets theEvent.Result
of this event. The Result describes the behavior that will be applied to the inventory in relation to this event.- Returns:
- the Result of this event.
-
isCancelled
public boolean isCancelled()Gets whether or not this event is cancelled. This is based off of the Result value returned bygetResult()
. Result.ALLOW and Result.DEFAULT will result in a returned value of false, but Result.DENY will result in a returned value of true.Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins
- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- whether the event is cancelled
-
setCancelled
public void setCancelled(boolean toCancel) Proxy method tosetResult(org.bukkit.event.Event.Result)
for the Cancellable interface.setResult(org.bukkit.event.Event.Result)
is preferred, as it allows you to specify the Result beyond Result.DENY and Result.ALLOW.Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
toCancel
- result becomes DENY if true, ALLOW if false
-