Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.player.PlayerAnimationEvent Class Reference
Inheritance diagram for org.bukkit.event.player.PlayerAnimationEvent:
org.bukkit.event.player.PlayerEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Public Member Functions

 PlayerAnimationEvent (final Player player)
 
PlayerAnimationType getAnimationType ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
 PlayerEvent (final Player who)
 
final Player getPlayer ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Additional Inherited Members

- Protected Attributes inherited from org.bukkit.event.player.PlayerEvent
Player player
 

Detailed Description

Represents a player animation event

Definition at line 10 of file PlayerAnimationEvent.java.

Constructor & Destructor Documentation

org.bukkit.event.player.PlayerAnimationEvent.PlayerAnimationEvent ( final Player  player)

Construct a new PlayerAnimation event

Parameters
playerThe player instance

Definition at line 20 of file PlayerAnimationEvent.java.

20  {
21  super(player);
22 
23  // Only supported animation type for now:
24  animationType = PlayerAnimationType.ARM_SWING;
25  }

Member Function Documentation

PlayerAnimationType org.bukkit.event.player.PlayerAnimationEvent.getAnimationType ( )

Get the type of this animation event

Returns
the animation type

Definition at line 32 of file PlayerAnimationEvent.java.

32  {
33  return animationType;
34  }
boolean org.bukkit.event.player.PlayerAnimationEvent.isCancelled ( )

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

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 36 of file PlayerAnimationEvent.java.

36  {
37  return this.isCancelled;
38  }
void org.bukkit.event.player.PlayerAnimationEvent.setCancelled ( boolean  cancel)

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

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 40 of file PlayerAnimationEvent.java.

40  {
41  this.isCancelled = cancel;
42  }

The documentation for this class was generated from the following file: