org.bukkit.event.player
Class PlayerInteractEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.player.PlayerEvent
          extended by org.bukkit.event.player.PlayerInteractEvent
All Implemented Interfaces:
Cancellable

public class PlayerInteractEvent
extends PlayerEvent
implements Cancellable

Called when a player interacts with an object or air.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Field Summary
protected  Action action
           
protected  Block blockClicked
           
protected  BlockFace blockFace
           
protected  ItemStack item
           
 
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
 
Constructor Summary
PlayerInteractEvent(Player who, Action action, ItemStack item, Block clickedBlock, BlockFace clickedFace)
           
 
Method Summary
 Action getAction()
          Returns the action type
 BlockFace getBlockFace()
          Returns the face of the block that was clicked
 Block getClickedBlock()
          Returns the clicked block
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 ItemStack getItem()
          Returns the item in hand represented by this event
 Material getMaterial()
          Convenience method.
 boolean hasBlock()
          Check if this event involved a block
 boolean hasItem()
          Check if this event involved an item
 boolean isBlockInHand()
          Convenience method to inform the user whether this was a block placement event.
 boolean isCancelled()
          Gets the cancellation state of this event.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 void setUseInteractedBlock(Event.Result useInteractedBlock)
           
 void setUseItemInHand(Event.Result useItemInHand)
           
 Event.Result useInteractedBlock()
          This controls the action to take with the block (if any) that was clicked on.
 Event.Result useItemInHand()
          This controls the action to take with the item the player is holding.
 
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
 
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

item

protected ItemStack item

action

protected Action action

blockClicked

protected Block blockClicked

blockFace

protected BlockFace blockFace
Constructor Detail

PlayerInteractEvent

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

getAction

public Action getAction()
Returns the action type

Returns:
Action returns the type of interaction

isCancelled

public boolean isCancelled()
Gets the cancellation state of this event. Set to true if you want to prevent buckets from placing water and so forth

Specified by:
isCancelled in interface Cancellable
Returns:
boolean cancellation state

setCancelled

public void setCancelled(boolean cancel)
Sets the cancellation state of this event. A canceled event will not be executed in the server, but will still pass to other plugins

Canceling this event will prevent use of food (player won't lose the food item), prevent bows/snowballs/eggs from firing, etc. (player won't lose the ammo)

Specified by:
setCancelled in interface Cancellable
Parameters:
cancel - true if you wish to cancel this event

getItem

public ItemStack getItem()
Returns the item in hand represented by this event

Returns:
ItemStack the item used

getMaterial

public Material getMaterial()
Convenience method. Returns the material of the item represented by this event

Returns:
Material the material of the item used

hasBlock

public boolean hasBlock()
Check if this event involved a block

Returns:
boolean true if it did

hasItem

public boolean hasItem()
Check if this event involved an item

Returns:
boolean true if it did

isBlockInHand

public boolean isBlockInHand()
Convenience method to inform the user whether this was a block placement event.

Returns:
boolean true if the item in hand was a block

getClickedBlock

public Block getClickedBlock()
Returns the clicked block

Returns:
Block returns the block clicked with this item.

getBlockFace

public BlockFace getBlockFace()
Returns the face of the block that was clicked

Returns:
BlockFace returns the face of the block that was clicked

useInteractedBlock

public Event.Result useInteractedBlock()
This controls the action to take with the block (if any) that was clicked on. This event gets processed for all blocks, but most don't have a default action

Returns:
the action to take with the interacted block

setUseInteractedBlock

public void setUseInteractedBlock(Event.Result useInteractedBlock)
Parameters:
useInteractedBlock - the action to take with the interacted block

useItemInHand

public Event.Result useItemInHand()
This controls the action to take with the item the player is holding. This includes both blocks and items (such as flint and steel or records). When this is set to default, it will be allowed if no action is taken on the interacted block.

Returns:
the action to take with the item in hand

setUseItemInHand

public void setUseItemInHand(Event.Result useItemInHand)
Parameters:
useItemInHand - the action to take with the item in hand

getHandlers

public HandlerList getHandlers()
Specified by:
getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2014. All rights reserved.