org.bukkit.event.entity.EntityChangeBlockEvent Maven / Gradle / Ivy

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

import org.bukkit.Material;
import org.bukkit.block.Block;
import org.bukkit.entity.Entity;
import org.bukkit.entity.LivingEntity;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;

/**
 * Called when any Entity, excluding players, changes a block.
 */
public class EntityChangeBlockEvent extends EntityEvent implements Cancellable {
  private static final HandlerList handlers = new HandlerList();
  private final Block block;
  private final Material to;
  private final byte data;
  private boolean cancel;

  /**
   * @param what  the LivingEntity causing the change
   * @param block the block (before the change)
   * @param to    the future material being changed to
   * @deprecated Provided as a backward compatibility before the data byte
   * was provided, and type increased to all entities
   */
  @Deprecated
  public EntityChangeBlockEvent(final LivingEntity what, final Block block, final Material to) {
    this(what, block, to, (byte) 0);
  }

  /**
   * @param what  the Entity causing the change
   * @param block the block (before the change)
   * @param to    the future material being changed to
   * @param data  the future block data
   * @deprecated Magic value
   */
  @Deprecated
  public EntityChangeBlockEvent(final Entity what, final Block block, final Material to, final byte data) {
    super(what);
    this.block = block;
    this.cancel = false;
    this.to = to;
    this.data = data;
  }

  public static HandlerList getHandlerList() {
    return handlers;
  }

  /**
   * Gets the block the entity is changing
   *
   * @return the block that is changing
   */
  public Block getBlock() {
    return block;
  }

  public boolean isCancelled() {
    return cancel;
  }

  public void setCancelled(boolean cancel) {
    this.cancel = cancel;
  }

  /**
   * Gets the Material that the block is changing into
   *
   * @return the material that the block is changing into
   */
  public Material getTo() {
    return to;
  }

  /**
   * Gets the data for the block that would be changed into
   *
   * @return the data for the block that would be changed into
   * @deprecated Magic value
   */
  @Deprecated
  public byte getData() {
    return data;
  }

  @Override
  public HandlerList getHandlers() {
    return handlers;
  }
}