org.bukkit.event.block.BlockPlaceEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of walk-server Show documentation
A spigot fork to kotlin structure and news.
There is a newer version: 2.4.0
package org.bukkit.event.block;

import org.bukkit.block.Block;
import org.bukkit.block.BlockState;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
import org.bukkit.inventory.ItemStack;

/**
 * Called when a block is placed by a player.
 * 
 * If a Block Place event is cancelled, the block will not be placed.
 */
public class BlockPlaceEvent extends BlockEvent implements Cancellable {
  private static final HandlerList handlers = new HandlerList();
  protected boolean cancel;
  protected boolean canBuild;
  protected Block placedAgainst;
  protected BlockState replacedBlockState;
  protected ItemStack itemInHand;
  protected Player player;

  public BlockPlaceEvent(final Block placedBlock, final BlockState replacedBlockState, final Block placedAgainst, final ItemStack itemInHand, final Player thePlayer, final boolean canBuild) {
    super(placedBlock);
    this.placedAgainst = placedAgainst;
    this.itemInHand = itemInHand;
    this.player = thePlayer;
    this.replacedBlockState = replacedBlockState;
    this.canBuild = canBuild;
    cancel = false;
  }

  public static HandlerList getHandlerList() {
    return handlers;
  }

  public boolean isCancelled() {
    return cancel;
  }

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

  /**
   * Gets the player who placed the block involved in this event.
   *
   * @return The Player who placed the block involved in this event
   */
  public Player getPlayer() {
    return player;
  }

  /**
   * Clarity method for getting the placed block. Not really needed except
   * for reasons of clarity.
   *
   * @return The Block that was placed
   */
  public Block getBlockPlaced() {
    return getBlock();
  }

  /**
   * Gets the BlockState for the block which was replaced. Material type air
   * mostly.
   *
   * @return The BlockState for the block which was replaced.
   */
  public BlockState getBlockReplacedState() {
    return this.replacedBlockState;
  }

  /**
   * Gets the block that this block was placed against
   *
   * @return Block the block that the new block was placed against
   */
  public Block getBlockAgainst() {
    return placedAgainst;
  }

  /**
   * Gets the item in the player's hand when they placed the block.
   *
   * @return The ItemStack for the item in the player's hand when they
   * placed the block
   */
  public ItemStack getItemInHand() {
    return itemInHand;
  }

  /**
   * Gets the value whether the player would be allowed to build here.
   * Defaults to spawn if the server was going to stop them (such as, the
   * player is in Spawn). Note that this is an entirely different check
   * than BLOCK_CANBUILD, as this refers to a player, not universe-physics
   * rule like cactus on dirt.
   *
   * @return boolean whether the server would allow a player to build here
   */
  public boolean canBuild() {
    return this.canBuild;
  }

  /**
   * Sets the canBuild state of this event. Set to true if you want the
   * player to be able to build.
   *
   * @param canBuild true if you want the player to be able to build
   */
  public void setBuild(boolean canBuild) {
    this.canBuild = canBuild;
  }

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