org.bukkit.event.player
Class PlayerInteractEntityEvent

java.lang.Object
  org.bukkit.event.Event
      org.bukkit.event.player.PlayerEvent
          org.bukkit.event.player.PlayerInteractEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerInteractEntityEvent
extends PlayerEvent
implements Cancellable

Represents an event that is called when a player right clicks an entity.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

protected Entity

clickedEntity

Fields inherited from class org.bukkit.event.player.PlayerEvent

player

Constructor Summary

PlayerInteractEntityEvent(Player who, Entity clickedEntity)

Method Summary

static HandlerList	getHandlerList()
HandlerList	getHandlers()
Entity	getRightClicked() Gets the entity that was rightclicked by the player.
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.

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

clickedEntity

protected Entity clickedEntity

Constructor Detail

PlayerInteractEntityEvent

public PlayerInteractEntityEvent(Player who,
                                 Entity clickedEntity)

Method Detail

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getRightClicked

public Entity getRightClicked()

Gets the entity that was rightclicked by the player.

Returns:

entity right clicked by player

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()