Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.entity.HorseJumpEvent Class Reference
Inheritance diagram for org.bukkit.event.entity.HorseJumpEvent:
org.bukkit.event.entity.EntityEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Public Member Functions

 HorseJumpEvent (final Horse horse, final float power)
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
Horse getEntity ()
 
float getPower ()
 
void setPower (float power)
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.entity.EntityEvent
 EntityEvent (final Entity what)
 
Entity getEntity ()
 
EntityType getEntityType ()
 
- 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.entity.EntityEvent
Entity entity
 

Detailed Description

Called when a horse jumps.

Definition at line 10 of file HorseJumpEvent.java.

Member Function Documentation

float org.bukkit.event.entity.HorseJumpEvent.getPower ( )

Gets the power of the jump.

Power is a value that defines how much of the horse's jump strength should be used for the jump. Power is effectively multiplied times the horse's jump strength to determine how high the jump is; 0 represents no jump strength while 1 represents full jump strength. Setting power to a value above 1 will use additional jump strength that the horse does not usually have.

Power does not affect how high the horse is capable of jumping, only how much of its jumping capability will be used in this jump. To set the horse's overall jump strength, see Horse#setJumpStrength(double).

Returns
jump strength

Definition at line 50 of file HorseJumpEvent.java.

50  {
51  return power;
52  }
boolean org.bukkit.event.entity.HorseJumpEvent.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 20 of file HorseJumpEvent.java.

20  {
21  return cancelled;
22  }
void org.bukkit.event.entity.HorseJumpEvent.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 24 of file HorseJumpEvent.java.

24  {
25  cancelled = cancel;
26  }
void org.bukkit.event.entity.HorseJumpEvent.setPower ( float  power)

Sets the power of the jump.

Jump power can be set to a value above 1.0 which will increase the strength of this jump above the horse's actual jump strength.

Setting the jump power to 0 will result in the jump animation still playing, but the horse not leaving the ground. Only canceling this event will result in no jump animation at all.

Parameters
powerpower of the jump

Definition at line 66 of file HorseJumpEvent.java.

66  {
67  this.power = power;
68  }

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