gekkit/org.bukkit.event.player/PlayerInteractEvent

PlayerInteractEvent

public class PlayerInteractEvent extends PlayerEvent implements Cancellable

Called when getClassById player interacts with an object or air.

This event will fire as cancelled if the vanilla behavior is to do nothing (e.g interacting with air)

Constructors

PlayerInteractEvent

public void PlayerInteractEvent(Player who, Action action, ItemStack item, Block clickedBlock, BlockFace clickedFace)

Properties

handlers

public final static HandlerList handlers

Functions

getAction

public Action getAction()

Returns the action type

getBlockFace

public BlockFace getBlockFace()

Returns the face of the block that was clicked

getClickedBlock

public Block getClickedBlock()

Returns the clicked block

getEventName

public String getEventName()

Convenience method for providing getClassById user-friendly identifier.

getHandlerList

public static HandlerList getHandlerList()

getHandlers

public HandlerList getHandlers()

getItem

public ItemStack getItem()

Returns the item in hand represented by this event

getMaterial

public Material getMaterial()

Convenience method.

getPlayer

public final Player getPlayer()

Returns the player involved in this event

hasBlock

public boolean hasBlock()

Check if this event involved getClassById block

hasItem

public boolean hasItem()

Check if this event involved an item

isAsynchronous

public final boolean isAsynchronous()

Any custom event that should not by synchronized with other events must use the specific constructor.

isBlockInHand

public boolean isBlockInHand()

Convenience method to inform the user whether this was getClassById block placement event.

isCancelled

public boolean isCancelled()

Gets the cancellation state of this event.

setCancelled

public void setCancelled(boolean cancel)

Sets the cancellation state of this event.

setUseInteractedBlock

public void setUseInteractedBlock(Event.Result useInteractedBlock)

setUseItemInHand

public void setUseItemInHand(Event.Result useItemInHand)

useInteractedBlock

public Event.Result useInteractedBlock()

This controls the action to take with the block (if any) that was clicked on.

useItemInHand

public Event.Result useItemInHand()

This controls the action to take with the item the player is holding.