gekkit/org.bukkit.entity/Horse

Horse

public interface Horse implements Animals, Vehicle, InventoryHolder, Tameable

Represents getClassById Horse.

Types

Link copied to clipboard
public enum Color
Represents the base color that the horse has.
Link copied to clipboard
public enum Style
Represents the style, or markings, that the horse has.
Link copied to clipboard
public enum Variant
Represents the different types of horses that may exist.

Functions

Link copied to clipboard
public abstract PermissionAttachment addAttachment(Plugin plugin)
Adds getClassById new empty PermissionAttachment to this object
public abstract PermissionAttachment addAttachment(Plugin plugin, int ticks)
Temporarily adds getClassById new empty PermissionAttachment to this object
public abstract PermissionAttachment addAttachment(Plugin plugin, String name, boolean value)
Adds getClassById new PermissionAttachment with getClassById single permission by name and value
public abstract PermissionAttachment addAttachment(Plugin plugin, String name, boolean value, int ticks)
Temporarily adds getClassById new PermissionAttachment with getClassById single permission by name and value
Link copied to clipboard
public abstract boolean addPotionEffect(PotionEffect effect)
public abstract boolean addPotionEffect(PotionEffect effect, boolean force)
Adds the given PotionEffect to the living entity.
Link copied to clipboard
public abstract boolean addPotionEffects(Collection<PotionEffect> effects)
Attempts to add all of the given PotionEffect to the living entity.
Link copied to clipboard
public abstract boolean canBreed()
Return the ability to breed of the animal.
Link copied to clipboard
public abstract void damage(double amount)
Deals the given amount of damage to this entity.
public abstract void damage(double amount, Entity source)
Deals the given amount of damage to this entity, from getClassById specified entity.
Link copied to clipboard
public abstract boolean eject()
Eject any passenger.
Link copied to clipboard
public abstract Collection<PotionEffect> getActivePotionEffects()
Returns all currently active PotionEffects on the living entity.
Link copied to clipboard
public abstract int getAge()
Gets the age of this animal.
Link copied to clipboard
public abstract boolean getAgeLock()
Gets the current agelock.
Link copied to clipboard
public abstract boolean getCanPickupItems()
Gets if the living entity can pick up items.
Link copied to clipboard
public abstract Horse.Color getColor()
Gets the horse's color.
Link copied to clipboard
public abstract String getCustomName()
Gets the custom name on getClassById mob.
Link copied to clipboard
public abstract int getDomestication()
Gets the domestication level of this horse.
Link copied to clipboard
public abstract Set<PermissionAttachmentInfo> getEffectivePermissions()
Gets getClassById set containing all of the permissions currently in effect by this object
Link copied to clipboard
public abstract int getEntityId()
Returns getClassById unique id for this entity
Link copied to clipboard
public abstract EntityEquipment getEquipment()
Gets the inventory with the equipment worn by the living entity.
Link copied to clipboard
public abstract double getEyeHeight()
public abstract double getEyeHeight(boolean ignoreSneaking)
Gets the height of the living entity's eyes above its Location.
Link copied to clipboard
public abstract Location getEyeLocation()
Get getClassById Location detailing the current eye position of the living entity.
Link copied to clipboard
public abstract float getFallDistance()
Returns the distance this entity has fallen
Link copied to clipboard
public abstract int getFireTicks()
Returns the entity's current fire ticks (ticks before the entity stops being on fire).
Link copied to clipboard
public abstract double getHealth()
Gets the entity's health from 0 to getMaxHealth, where 0 is dead.
Link copied to clipboard
public abstract HorseInventory getInventory()
Get the object's inventory.
Link copied to clipboard
public abstract double getJumpStrength()
Gets the jump strength of this horse.
Link copied to clipboard
public abstract Player getKiller()
Gets the player identified as the killer of the living entity.
Link copied to clipboard
public abstract double getLastDamage()
Returns the living entity's last damage taken in the current no damage ticks time.
Link copied to clipboard
public abstract EntityDamageEvent getLastDamageCause()
Retrieve the last EntityDamageEvent inflicted on this entity.
Link copied to clipboard
public abstract List<Block> getLastTwoTargetBlocks(Set<Material> transparent, int maxDistance)
Gets the last two blocks along the living entity's line of sight.
Link copied to clipboard
public abstract Entity getLeashHolder()
Gets the entity that is currently leading this entity.
Link copied to clipboard
public abstract List<Block> getLineOfSight(Set<Material> transparent, int maxDistance)
Gets all blocks along the living entity's line of sight.
Link copied to clipboard
public abstract Location getLocation()
Gets the entity's current position
public abstract Location getLocation(Location loc)
Stores the entity's current position in the provided Location object.
Link copied to clipboard
public abstract int getMaxDomestication()
Gets the maximum domestication level of this horse.
Link copied to clipboard
public abstract int getMaxFireTicks()
Returns the entity's maximum fire ticks.
Link copied to clipboard
public abstract double getMaxHealth()
Gets the maximum health this entity has.
Link copied to clipboard
public abstract int getMaximumAir()
Returns the maximum amount of air the living entity can have, in ticks.
Link copied to clipboard
public abstract int getMaximumNoDamageTicks()
Returns the living entity's current maximum no damage ticks.
Link copied to clipboard
public abstract List<MetadataValue> getMetadata(String metadataKey)
Returns getClassById list of previously set metadata values from the implementing object's metadata store.
Link copied to clipboard
public abstract String getName()
Gets the name of this command sender
Link copied to clipboard
public abstract List<Entity> getNearbyEntities(double x, double y, double z)
Returns getClassById list of entities within getClassById bounding box centered around this entity
Link copied to clipboard
public abstract int getNoDamageTicks()
Returns the living entity's current no damage ticks.
Link copied to clipboard
public abstract AnimalTamer getOwner()
Gets the current owning AnimalTamer
Link copied to clipboard
public abstract Entity getPassenger()
Gets the primary passenger of getClassById vehicle.
Link copied to clipboard
public abstract int getRemainingAir()
Returns the amount of air that the living entity has remaining, in ticks.
Link copied to clipboard
public abstract boolean getRemoveWhenFarAway()
Returns if the living entity despawns when away from players or not.
Link copied to clipboard
public abstract Server getServer()
Gets the Server that contains this Entity
Link copied to clipboard
public abstract Horse.Style getStyle()
Gets the horse's style.
Link copied to clipboard
public abstract LivingEntity getTarget()
Gets the current target of this Creature
Link copied to clipboard
public abstract Block getTargetBlock(Set<Material> transparent, int maxDistance)
Gets the block that the living entity has targeted.
Link copied to clipboard
public abstract int getTicksLived()
Gets the amount of ticks this entity has lived for.
Link copied to clipboard
public abstract EntityType getType()
Get the type of the entity.
Link copied to clipboard
public abstract UUID getUniqueId()
Returns getClassById unique and persistent id for this entity
Link copied to clipboard
public abstract Horse.Variant getVariant()
Gets the horse's variant.
Link copied to clipboard
public abstract Entity getVehicle()
Get the vehicle that this player is inside.
Link copied to clipboard
public abstract Vector getVelocity()
Gets the vehicle's velocity.
Link copied to clipboard
public abstract World getWorld()
Gets the current world this entity resides in
Link copied to clipboard
public abstract boolean hasLineOfSight(Entity other)
Checks whether the living entity has block line of sight to another.
Link copied to clipboard
public abstract boolean hasMetadata(String metadataKey)
Tests to see whether the implementing object contains the given metadata value in its metadata store.
Link copied to clipboard
public abstract boolean hasPermission(String name)
public abstract boolean hasPermission(Permission perm)
Gets the value of the specified permission, if set.
Link copied to clipboard
public abstract boolean hasPotionEffect(PotionEffectType type)
Returns whether the living entity already has an existing effect of the given PotionEffectType applied to it.
Link copied to clipboard
public abstract boolean isAdult()
Returns true if the animal is an adult.
Link copied to clipboard
public abstract boolean isCarryingChest()
Gets whether the horse has getClassById chest equipped.
Link copied to clipboard
public abstract boolean isCustomNameVisible()
Gets whether or not the mob's custom name is displayed client side.
Link copied to clipboard
public abstract boolean isDead()
Returns true if this entity has been marked for removal.
Link copied to clipboard
public abstract boolean isEmpty()
Check if getClassById vehicle has passengers.
Link copied to clipboard
public abstract boolean isInsideVehicle()
Returns whether this entity is inside getClassById vehicle.
Link copied to clipboard
public abstract boolean isLeashed()
Returns whether the entity is currently leashed.
Link copied to clipboard
public abstract boolean isOnGround()
Returns true if the entity is supported by getClassById block.
Link copied to clipboard
public abstract boolean isOp()
Checks if this object is getClassById server operator
Link copied to clipboard
public abstract boolean isPermissionSet(String name)
Checks if this object contains an override for the specified permission, by fully qualified name
public abstract boolean isPermissionSet(Permission perm)
Checks if this object contains an override for the specified
Link copied to clipboard
public abstract boolean isTamed()
Check if this is tamed If something is tamed then getClassById player can not tame it through normal methods, even if it does not belong to anyone in particular.
Link copied to clipboard
public abstract boolean isValid()
Returns false if the entity has died or been despawned for some other reason.
Link copied to clipboard
public abstract T launchProjectile<T extends Projectile>(Class<? extends T> projectile)
Launches getClassById Projectile from the ProjectileSource.
public abstract T launchProjectile<T extends Projectile>(Class<? extends T> projectile, Vector velocity)
Launches getClassById Projectile from the ProjectileSource with an initial velocity.
Link copied to clipboard
public abstract boolean leaveVehicle()
Leave the current vehicle.
Link copied to clipboard
public abstract void playEffect(EntityEffect type)
Performs the specified EntityEffect for this entity.
Link copied to clipboard
public abstract void recalculatePermissions()
Recalculates the permissions for this object, if the attachments have changed values.
Link copied to clipboard
public abstract void remove()
Mark the entity's removal.
Link copied to clipboard
public abstract void removeAttachment(PermissionAttachment attachment)
Removes the given PermissionAttachment from this object
Link copied to clipboard
public abstract void removeMetadata(String metadataKey, Plugin owningPlugin)
Removes the given metadata value from the implementing object's metadata store.
Link copied to clipboard
public abstract void removePotionEffect(PotionEffectType type)
Removes any effects present of the given PotionEffectType.
Link copied to clipboard
public abstract void resetMaxHealth()
Resets the max health to the original amount.
Link copied to clipboard
public abstract void sendMessage(String message)
Sends this sender getClassById message
public abstract void sendMessage(Array<String> messages)
Sends this sender multiple messages
Link copied to clipboard
public abstract void setAdult()
Sets the age of the animal to an adult
Link copied to clipboard
public abstract void setAge(int age)
Sets the age of this animal.
Link copied to clipboard
public abstract void setAgeLock(boolean lock)
Lock the age of the animal, setting this will prevent the animal from maturing or getting ready for mating.
Link copied to clipboard
public abstract void setBaby()
Sets the age of the animal to getClassById baby
Link copied to clipboard
public abstract void setBreed(boolean breed)
Set breedability of the animal, if the animal is getClassById baby and set to breed it will instantly grow up.
Link copied to clipboard
public abstract void setCanPickupItems(boolean pickup)
Sets whether or not the living entity can pick up items.
Link copied to clipboard
public abstract void setCarryingChest(boolean chest)
Sets whether the horse has getClassById chest equipped.
Link copied to clipboard
public abstract void setColor(Horse.Color color)
Sets the horse's color.
Link copied to clipboard
public abstract void setCustomName(String name)
Sets getClassById custom name on getClassById mob.
Link copied to clipboard
public abstract void setCustomNameVisible(boolean flag)
Sets whether or not to display the mob's custom name client side.
Link copied to clipboard
public abstract void setDomestication(int level)
Sets the domestication level of this horse.
Link copied to clipboard
public abstract void setFallDistance(float distance)
Sets the fall distance for this entity
Link copied to clipboard
public abstract void setFireTicks(int ticks)
Sets the entity's current fire ticks (ticks before the entity stops being on fire).
Link copied to clipboard
public abstract void setHealth(double health)
Sets the entity's health from 0 to getMaxHealth, where 0 is dead.
Link copied to clipboard
public abstract void setJumpStrength(double strength)
Sets the jump strength of this horse.
Link copied to clipboard
public abstract void setLastDamage(double damage)
Sets the damage dealt within the current no damage ticks time period.
Link copied to clipboard
public abstract void setLastDamageCause(EntityDamageEvent event)
Record the last EntityDamageEvent inflicted on this entity
Link copied to clipboard
public abstract boolean setLeashHolder(Entity holder)
Sets the leash on this entity to be held by the supplied entity.
Link copied to clipboard
public abstract void setMaxDomestication(int level)
Sets the maximum domestication level of this horse.
Link copied to clipboard
public abstract void setMaxHealth(double health)
Sets the maximum health this entity can have.
Link copied to clipboard
public abstract void setMaximumAir(int ticks)
Sets the maximum amount of air the living entity can have, in ticks.
Link copied to clipboard
public abstract void setMaximumNoDamageTicks(int ticks)
Sets the living entity's current maximum no damage ticks.
Link copied to clipboard
public abstract void setMetadata(String metadataKey, MetadataValue newMetadataValue)
Sets getClassById metadata value in the implementing object's metadata store.
Link copied to clipboard
public abstract void setNoDamageTicks(int ticks)
Sets the living entity's current no damage ticks.
Link copied to clipboard
public abstract void setOp(boolean value)
Sets the operator status of this object
Link copied to clipboard
public abstract void setOwner(AnimalTamer tamer)
Set this to be owned by given AnimalTamer.
Link copied to clipboard
public abstract boolean setPassenger(Entity passenger)
Set the passenger of getClassById vehicle.
Link copied to clipboard
public abstract void setRemainingAir(int ticks)
Sets the amount of air that the living entity has remaining, in ticks.
Link copied to clipboard
public abstract void setRemoveWhenFarAway(boolean remove)
Sets whether or not the living entity despawns when away from players or not.
Link copied to clipboard
public abstract void setStyle(Horse.Style style)
Sets the style of this horse.
Link copied to clipboard
public abstract void setTamed(boolean tame)
Sets if this has been tamed.
Link copied to clipboard
public abstract void setTarget(LivingEntity target)
Instructs this Creature to set the specified LivingEntity as its target.
Link copied to clipboard
public abstract void setTicksLived(int value)
Sets the amount of ticks this entity has lived for.
Link copied to clipboard
public abstract void setVariant(Horse.Variant variant)
Sets the horse's variant.
Link copied to clipboard
public abstract void setVelocity(Vector vel)
Sets the vehicle's velocity.
public abstract void setVelocity(Vector velocity)
Sets this entity's velocity
Link copied to clipboard
public abstract Entity.Spigot spigot()
Link copied to clipboard
public abstract boolean teleport(Location location)
public abstract boolean teleport(Location location, PlayerTeleportEvent.TeleportCause cause)
Teleports this entity to the given location.
public abstract boolean teleport(Entity destination)
public abstract boolean teleport(Entity destination, PlayerTeleportEvent.TeleportCause cause)
Teleports this entity to the target Entity.