Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.entity.Horse Interface Reference
Inheritance diagram for org.bukkit.entity.Horse:
org.bukkit.entity.Animals org.bukkit.entity.Vehicle org.bukkit.inventory.InventoryHolder org.bukkit.entity.Tameable org.bukkit.entity.Ageable org.bukkit.entity.Entity org.bukkit.entity.Creature org.bukkit.metadata.Metadatable org.bukkit.entity.LivingEntity org.bukkit.entity.Entity org.bukkit.entity.Damageable org.bukkit.projectiles.ProjectileSource org.bukkit.metadata.Metadatable org.bukkit.entity.Entity org.bukkit.metadata.Metadatable

Classes

enum  Color
 
enum  Style
 
enum  Variant
 

Public Member Functions

Variant getVariant ()
 
void setVariant (Variant variant)
 
Color getColor ()
 
void setColor (Color color)
 
Style getStyle ()
 
void setStyle (Style style)
 
boolean isCarryingChest ()
 
void setCarryingChest (boolean chest)
 
int getDomestication ()
 
void setDomestication (int level)
 
int getMaxDomestication ()
 
void setMaxDomestication (int level)
 
double getJumpStrength ()
 
void setJumpStrength (double strength)
 
HorseInventory getInventory ()
 
- Public Member Functions inherited from org.bukkit.entity.Ageable
int getAge ()
 
void setAge (int age)
 
void setAgeLock (boolean lock)
 
boolean getAgeLock ()
 
void setBaby ()
 
void setAdult ()
 
boolean isAdult ()
 
boolean canBreed ()
 
void setBreed (boolean breed)
 
- Public Member Functions inherited from org.bukkit.entity.Creature
void setTarget (LivingEntity target)
 
LivingEntity getTarget ()
 
- Public Member Functions inherited from org.bukkit.entity.LivingEntity
double getEyeHeight ()
 
double getEyeHeight (boolean ignoreSneaking)
 
Location getEyeLocation ()
 
List< BlockgetLineOfSight (HashSet< Byte > transparent, int maxDistance)
 
Block getTargetBlock (HashSet< Byte > transparent, int maxDistance)
 
List< BlockgetLastTwoTargetBlocks (HashSet< Byte > transparent, int maxDistance)
 
Egg throwEgg ()
 
Snowball throwSnowball ()
 
Arrow shootArrow ()
 
int getRemainingAir ()
 
void setRemainingAir (int ticks)
 
int getMaximumAir ()
 
void setMaximumAir (int ticks)
 
int getMaximumNoDamageTicks ()
 
void setMaximumNoDamageTicks (int ticks)
 
double getLastDamage ()
 
int _INVALID_getLastDamage ()
 
void setLastDamage (double damage)
 
void _INVALID_setLastDamage (int damage)
 
int getNoDamageTicks ()
 
void setNoDamageTicks (int ticks)
 
Player getKiller ()
 
boolean addPotionEffect (PotionEffect effect)
 
boolean addPotionEffect (PotionEffect effect, boolean force)
 
boolean addPotionEffects (Collection< PotionEffect > effects)
 
boolean hasPotionEffect (PotionEffectType type)
 
void removePotionEffect (PotionEffectType type)
 
Collection< PotionEffectgetActivePotionEffects ()
 
boolean hasLineOfSight (Entity other)
 
boolean getRemoveWhenFarAway ()
 
void setRemoveWhenFarAway (boolean remove)
 
EntityEquipment getEquipment ()
 
void setCanPickupItems (boolean pickup)
 
boolean getCanPickupItems ()
 
void setCustomName (String name)
 
String getCustomName ()
 
void setCustomNameVisible (boolean flag)
 
boolean isCustomNameVisible ()
 
boolean isLeashed ()
 
Entity getLeashHolder () throws IllegalStateException
 
boolean setLeashHolder (Entity holder)
 
- Public Member Functions inherited from org.bukkit.entity.Entity
Location getLocation ()
 
Location getLocation (Location loc)
 
boolean isOnGround ()
 
World getWorld ()
 
boolean teleport (Location location)
 
boolean teleport (Location location, TeleportCause cause)
 
boolean teleport (Entity destination)
 
boolean teleport (Entity destination, TeleportCause cause)
 
List< org.bukkit.entity.EntitygetNearbyEntities (double x, double y, double z)
 
int getEntityId ()
 
int getFireTicks ()
 
int getMaxFireTicks ()
 
void setFireTicks (int ticks)
 
void remove ()
 
boolean isDead ()
 
boolean isValid ()
 
Server getServer ()
 
abstract Entity getPassenger ()
 
abstract boolean setPassenger (Entity passenger)
 
abstract boolean isEmpty ()
 
abstract boolean eject ()
 
float getFallDistance ()
 
void setFallDistance (float distance)
 
void setLastDamageCause (EntityDamageEvent event)
 
EntityDamageEvent getLastDamageCause ()
 
UUID getUniqueId ()
 
int getTicksLived ()
 
void setTicksLived (int value)
 
void playEffect (EntityEffect type)
 
EntityType getType ()
 
boolean isInsideVehicle ()
 
boolean leaveVehicle ()
 
Entity getVehicle ()
 
- Public Member Functions inherited from org.bukkit.entity.Damageable
void damage (double amount)
 
void _INVALID_damage (int amount)
 
void damage (double amount, Entity source)
 
void _INVALID_damage (int amount, Entity source)
 
double getHealth ()
 
int _INVALID_getHealth ()
 
void setHealth (double health)
 
void _INVALID_setHealth (int health)
 
double getMaxHealth ()
 
int _INVALID_getMaxHealth ()
 
void setMaxHealth (double health)
 
void _INVALID_setMaxHealth (int health)
 
void resetMaxHealth ()
 
- Public Member Functions inherited from org.bukkit.projectiles.ProjectileSource
public< T extends Projectile > T launchProjectile (Class<?extends T > projectile)
 
public< T extends Projectile > T launchProjectile (Class<?extends T > projectile, Vector velocity)
 
- Public Member Functions inherited from org.bukkit.entity.Vehicle
Vector getVelocity ()
 
void setVelocity (Vector vel)
 
- Public Member Functions inherited from org.bukkit.entity.Tameable
boolean isTamed ()
 
void setTamed (boolean tame)
 
AnimalTamer getOwner ()
 
void setOwner (AnimalTamer tamer)
 

Detailed Description

Represents a Horse.

Definition at line 9 of file Horse.java.

Member Function Documentation

Color org.bukkit.entity.Horse.getColor ( )

Gets the horse's color.

Colors only apply to horses, not to donkeys, mules, skeleton horses or undead horses.

Returns
a Color representing the horse's group
int org.bukkit.entity.Horse.getDomestication ( )

Gets the domestication level of this horse.

A higher domestication level indicates that the horse is closer to becoming tame. As the domestication level gets closer to the max domestication level, the chance of the horse becoming tame increases.

Returns
domestication level
HorseInventory org.bukkit.entity.Horse.getInventory ( )

Get the object's inventory.

Returns
The inventory.

Implements org.bukkit.inventory.InventoryHolder.

double org.bukkit.entity.Horse.getJumpStrength ( )

Gets the jump strength of this horse.

Jump strength defines how high the horse can jump. A higher jump strength increases how high a jump will go.

Returns
the horse's jump strength
int org.bukkit.entity.Horse.getMaxDomestication ( )

Gets the maximum domestication level of this horse.

The higher this level is, the longer it will likely take for the horse to be tamed.

Returns
the max domestication level
Style org.bukkit.entity.Horse.getStyle ( )

Gets the horse's style. Styles determine what kind of markings or patterns a horse has.

Styles only apply to horses, not to donkeys, mules, skeleton horses or undead horses.

Returns
a Style representing the horse's style
Variant org.bukkit.entity.Horse.getVariant ( )

Gets the horse's variant.

A horse's variant defines its physical appearance and capabilities. Whether a horse is a regular horse, donkey, mule, or other kind of horse is determined using the variant.

Returns
a Variant representing the horse's variant
boolean org.bukkit.entity.Horse.isCarryingChest ( )

Gets whether the horse has a chest equipped.

Returns
true if the horse has chest storage
void org.bukkit.entity.Horse.setCarryingChest ( boolean  chest)

Sets whether the horse has a chest equipped. Removing a chest will also clear the chest's inventory.

Parameters
chesttrue if the horse should have a chest
void org.bukkit.entity.Horse.setColor ( Color  color)

Sets the horse's color.

Attempting to set a color for any donkey, mule, skeleton horse or undead horse will not result in a change.

Parameters
colora Color for this horse
void org.bukkit.entity.Horse.setDomestication ( int  level)

Sets the domestication level of this horse.

Setting the domestication level to a high value will increase the horse's chances of becoming tame.

Domestication level must be greater than zero and no greater than the max domestication level of the horse, determined with getMaxDomestication()

Parameters
leveldomestication level
void org.bukkit.entity.Horse.setJumpStrength ( double  strength)

Sets the jump strength of this horse.

A higher jump strength increases how high a jump will go. Setting a jump strength to 0 will result in no jump. You cannot set a jump strength to a value below 0 or above 2.

Parameters
strengthjump strength for this horse
void org.bukkit.entity.Horse.setMaxDomestication ( int  level)

Sets the maximum domestication level of this horse.

Setting a higher max domestication will increase the amount of domesticating (feeding, riding, etc.) necessary in order to tame it, while setting a lower max value will have the opposite effect.

Maximum domestication must be greater than zero.

Parameters
levelthe max domestication level
void org.bukkit.entity.Horse.setStyle ( Style  style)

Sets the style of this horse. Styles determine what kind of markings or patterns a horse has.

Attempting to set a style for any donkey, mule, skeleton horse or undead horse will not result in a change.

Parameters
stylea Style for this horse
void org.bukkit.entity.Horse.setVariant ( Variant  variant)

Sets the horse's variant.

A horse's variant defines its physical appearance and capabilities. Whether a horse is a regular horse, donkey, mule, or other kind of horse can be set using the variant.

Setting a horse's variant does not change its attributes such as its owner and its tamed status, but changing a mule or donkey with a chest to another variant which does not support a chest will remove the chest and its contents.

Parameters
varianta Variant for this horse

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