org.bukkit.event.inventory.InventoryInteractEvent Maven / Gradle / Ivy

Go to download
package org.bukkit.event.inventory;

import org.bukkit.entity.HumanEntity;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.inventory.InventoryView;

/**
 * An abstract base class for events that describe an interaction between a
 * HumanEntity and the contents of an Inventory.
 */
public abstract class InventoryInteractEvent extends InventoryEvent implements Cancellable {
   private Result result = Result.DEFAULT;

   public InventoryInteractEvent(InventoryView transaction) {
      super(transaction);
   }

   /**
    * Gets the player who performed the click.
    *
    * @return The clicking player.
    */
   public HumanEntity getWhoClicked() {
      return getView().getPlayer();
   }

   /**
    * Gets the player who performed the click.
    *
    * @return the clicking player casted.
    */
   public Player getPlayer() {
      return (Player) getWhoClicked();
   }

   /**
    * Gets the {@link Result} of this event. The Result describes the
    * behavior that will be applied to the inventory in relation to this
    * event.
    *
    * @return the Result of this event.
    */
   public Result getResult() {
      return result;
   }

   /**
    * Sets the result of this event. This will change whether or not this
    * event is considered cancelled.
    *
    * @param newResult the new {@link Result} for this event
    * @see #isCancelled()
    */
   public void setResult(Result newResult) {
      result = newResult;
   }

   /**
    * Gets whether or not this event is cancelled. This is based off of the
    * Result value returned by {@link #getResult()}.  Result.ALLOW and
    * Result.DEFAULT will result in a returned value of false, but
    * Result.DENY will result in a returned value of true.
    * 
    * {@inheritDoc}
    *
    * @return whether the event is cancelled
    */
   public boolean isCancelled() {
      return getResult() == Result.DENY;
   }

   /**
    * Proxy method to {@link #setResult(Result)} for the Cancellable
    * interface. {@link #setResult(Result)} is preferred, as it allows
    * you to specify the Result beyond Result.DENY and Result.ALLOW.
    * 
    * {@inheritDoc}
    *
    * @param toCancel result becomes DENY if true, ALLOW if false
    */
   public void setCancelled(boolean toCancel) {
      setResult(toCancel ? Result.DENY : Result.ALLOW);
   }

}