Package org.bukkit.entity

Interface Horse

All Superinterfaces:

AbstractHorse, Ageable, Animals, Attributable, Audience, Breedable, CommandSender, Creature, Damageable, Entity, Frictional, HoverEventSource<HoverEvent.ShowEntity>, InventoryHolder, LivingEntity, Lootable, Metadatable, Mob, Nameable, Permissible, PersistentDataHolder, Pointered, ProjectileSource, ServerOperator, Sound.Emitter, Tameable, Vehicle

public interface Horse
extends AbstractHorse

Represents a Horse.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Horse.Color	Represents the base color that the horse has.
static enum	Horse.Style	Represents the style, or markings, that the horse has.
static enum	Horse.Variant	Deprecated. different variants are differing classes

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
@NotNull Horse.Color	getColor()	Gets the horse's color.
@NotNull HorseInventory	getInventory()	Get the object's inventory.
@NotNull Horse.Style	getStyle()	Gets the horse's style.
boolean	isCarryingChest()	Deprecated. see ChestedHorse
void	setCarryingChest(boolean chest)	Deprecated. see ChestedHorse
void	setColor(@NotNull Horse.Color color)	Sets the horse's color.
void	setStyle(@NotNull Horse.Style style)	Sets the style of this horse.

Methods inherited from interface org.bukkit.entity.AbstractHorse

getDomestication, getJumpStrength, getMaxDomestication, getVariant, isEating, isEatingGrass, isEatingHaystack, isRearing, setDomestication, setEating, setEatingGrass, setEatingHaystack, setJumpStrength, setMaxDomestication, setRearing, setVariant

Methods inherited from interface org.bukkit.entity.Ageable

getAge, isAdult, setAdult, setAge, setBaby

Methods inherited from interface org.bukkit.entity.Animals

getBreedCause, getLoveModeTicks, isBreedItem, isBreedItem, isLoveMode, setBreedCause, setLoveModeTicks

Methods inherited from interface org.bukkit.attribute.Attributable

getAttribute, registerAttribute

Methods inherited from interface net.kyori.adventure.audience.Audience

clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendTitlePart, showBossBar, showTitle, stopSound, stopSound

Methods inherited from interface org.bukkit.entity.Breedable

canBreed, getAgeLock, setAgeLock, setBreed

Methods inherited from interface org.bukkit.command.CommandSender

getName, name, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlainMessage, sendRichMessage

Methods inherited from interface org.bukkit.entity.Damageable

damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, collidesAt, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScheduler, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedPlayers, getType, getUniqueId, getVehicle, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isInBubbleColumn, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isSneaking, isTicking, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setSneaking, setTicksLived, setVisibleByDefault, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync, wouldCollideUsing

Methods inherited from interface io.papermc.paper.entity.Frictional

getFrictionState, setFrictionState

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface org.bukkit.entity.LivingEntity

addPotionEffect, addPotionEffect, addPotionEffects, attack, broadcastSlotBreak, broadcastSlotBreak, canBreatheUnderwater, clearActiveItem, damageItemStack, damageItemStack, getActiveItem, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getArrowsStuck, getBeeStingerCooldown, getBeeStingersInBody, getBodyYaw, getCanPickupItems, getCategory, getCollidableExemptions, getDeathSound, getDrinkingSound, getEatingSound, getEyeHeight, getEyeHeight, getEyeLocation, getFallDamageSound, getFallDamageSoundBig, getFallDamageSoundSmall, getHandRaised, getHandRaisedTime, getHurtDirection, getHurtSound, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, hasAI, hasLineOfSight, hasLineOfSight, hasPotionEffect, isClimbing, isCollidable, isGliding, isHandRaised, isInvisible, isJumping, isLeashed, isRiptiding, isSleeping, isSwimming, knockback, playPickupItemAnimation, playPickupItemAnimation, rayTraceBlocks, rayTraceBlocks, rayTraceEntities, rayTraceEntities, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setArrowsInBody, setArrowsStuck, setBeeStingerCooldown, setBeeStingersInBody, setBodyYaw, setCanPickupItems, setCollidable, setGliding, setHurtDirection, setInvisible, setJumping, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setShieldBlockingDelay, setSwimming, swingHand, swingMainHand, swingOffHand

Methods inherited from interface org.bukkit.loot.Lootable

clearLootTable, getLootTable, getSeed, hasLootTable, setLootTable, setLootTable, setSeed

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.entity.Mob

getAmbientSound, getEquipment, getHeadRotationSpeed, getMaxHeadPitch, getPathfinder, getTarget, isAware, isInDaylight, isLeftHanded, lookAt, lookAt, lookAt, lookAt, lookAt, lookAt, setAware, setLeftHanded, setTarget

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, permissionValue, permissionValue, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.pointer.Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

launchProjectile, launchProjectile, launchProjectile

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.entity.Tameable

getOwner, getOwnerUniqueId, isTamed, setOwner, setTamed

Methods inherited from interface org.bukkit.entity.Vehicle

getVelocity, setVelocity

Method Details

getColor

@NotNull
@NotNull Horse.Color getColor()

Gets the horse's color.

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

Returns:

a Horse.Color representing the horse's group

setColor

void setColor(@NotNull
 @NotNull Horse.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:

color - a Horse.Color for this horse

getStyle

@NotNull
@NotNull Horse.Style 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 Horse.Style representing the horse's style

setStyle

void setStyle(@NotNull
 @NotNull Horse.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:

style - a Horse.Style for this horse

isCarryingChest

@Deprecated
boolean isCarryingChest()

Deprecated.

see ChestedHorse

Returns:

carrying chest status

setCarryingChest

@Deprecated
void setCarryingChest(boolean chest)

Deprecated.

see ChestedHorse

Parameters:

chest - chest

getInventory

@NotNull
@NotNull HorseInventory getInventory()

Description copied from interface: InventoryHolder

Get the object's inventory.

Specified by:

getInventory in interface AbstractHorse

Specified by:

getInventory in interface InventoryHolder

Returns:

The inventory.