Interface AbstractHorse
- All Superinterfaces:
Ageable
,Animals
,Attributable
,Audience
,Breedable
,CommandSender
,Creature
,Damageable
,Entity
,Frictional
,HoverEventSource<HoverEvent.ShowEntity>
,InventoryHolder
,Leashable
,LivingEntity
,Lootable
,Metadatable
,Mob
,Nameable
,Permissible
,PersistentDataHolder
,PersistentDataViewHolder
,Pointered
,ProjectileSource
,ServerOperator
,Sound.Emitter
,Tameable
,Vehicle
- All Known Subinterfaces:
Camel
,ChestedHorse
,Donkey
,Horse
,Llama
,Mule
,SkeletonHorse
,TraderLlama
,ZombieHorse
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.bukkit.entity.Entity
Entity.Spigot
-
Method Summary
Modifier and TypeMethodDescriptionint
Gets the domestication level of this horse.Get the object's inventory.double
Gets the jump strength of this horse.int
Gets the maximum domestication level of this horse.Deprecated.different variants are different classesboolean
isEating()
Gets if a horse is in their eating animation.boolean
Gets if a horse is in their eating grass animation.boolean
Deprecated.useisEatingGrass()
, this name is incorrectboolean
Gets if a horse is in their rearing animation.void
setDomestication
(int level) Sets the domestication level of this horse.void
setEating
(boolean eating) Sets if a horse is in their eating animation.void
setEatingGrass
(boolean eating) Sets if a horse is in their eating grass animation.void
setEatingHaystack
(boolean eatingHaystack) Deprecated.usesetEatingGrass(boolean)
, this name is incorrectvoid
setJumpStrength
(double strength) Sets the jump strength of this horse.void
setMaxDomestication
(int level) Sets the maximum domestication level of this horse.void
setRearing
(boolean rearing) Sets if a horse is in their rearing animation.void
setVariant
(Horse.Variant variant) Deprecated.you are required to spawn a different entityMethods 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
clearResourcePacks, clearTitle, deleteMessage, deleteMessage, filterAudience, forEachAudience, hideBossBar, openBook, openBook, playSound, playSound, playSound, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, sendResourcePacks, 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, sendRichMessage
Methods inherited from interface org.bukkit.entity.Damageable
damage, damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, heal, heal, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth
Methods inherited from interface org.bukkit.entity.Entity
addPassenger, addScoreboardTag, asHoverEvent, broadcastHurtAnimation, collidesAt, copy, copy, createSnapshot, eject, fromMobSpawner, getAsString, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getFreezeTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getMaxFreezeTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPitch, getPortalCooldown, getPose, getScheduler, getScoreboardEntryName, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getTrackedPlayers, getType, getUniqueId, getVehicle, getWidth, getWorld, getX, getY, getYaw, getZ, hasFixedPose, hasGravity, hasNoPhysics, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isInBubbleColumn, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isInWorld, isOnGround, isPersistent, isSilent, isSneaking, isTicking, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setNoPhysics, setPassenger, setPersistent, setPortalCooldown, setPose, setPose, setRotation, setSilent, setSneaking, setTicksLived, setVisibleByDefault, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, 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 io.papermc.paper.entity.Leashable
getLeashHolder, isLeashed, setLeashHolder
Methods inherited from interface org.bukkit.entity.LivingEntity
addPotionEffect, addPotionEffect, addPotionEffects, attack, broadcastSlotBreak, broadcastSlotBreak, canBreatheUnderwater, canUseEquipmentSlot, clearActiveItem, clearActivePotionEffects, completeUsingActiveItem, damageItemStack, damageItemStack, getActiveItem, getActiveItemHand, getActiveItemRemainingTime, getActiveItemUsedTime, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getArrowsStuck, getBeeStingerCooldown, getBeeStingersInBody, getBodyYaw, getCanPickupItems, getCategory, getCollidableExemptions, getDeathSound, getDrinkingSound, getEatingSound, getEyeHeight, getEyeHeight, getEyeLocation, getFallDamageSound, getFallDamageSoundBig, getFallDamageSoundSmall, getForwardsMovement, getHandRaised, getHandRaisedTime, getHurtDirection, getHurtSound, getItemInUse, getItemInUseTicks, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNextArrowRemoval, getNextBeeStingerRemoval, getNoActionTicks, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getSidewaysMovement, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, getUpwardsMovement, hasActiveItem, hasAI, hasLineOfSight, hasLineOfSight, hasPotionEffect, isClimbing, isCollidable, isGliding, isHandRaised, isInvisible, isJumping, isLeashed, isRiptiding, isSleeping, isSwimming, knockback, playHurtAnimation, playPickupItemAnimation, playPickupItemAnimation, rayTraceBlocks, rayTraceBlocks, rayTraceEntities, rayTraceEntities, removePotionEffect, setActiveItemRemainingTime, setAI, setArrowCooldown, setArrowsInBody, setArrowsInBody, setArrowsStuck, setBeeStingerCooldown, setBeeStingersInBody, setBodyYaw, setCanPickupItems, setCollidable, setGliding, setHurtDirection, setInvisible, setItemInUseTicks, setJumping, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNextArrowRemoval, setNextBeeStingerRemoval, setNoActionTicks, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setRiptiding, setShieldBlockingDelay, setSwimming, startUsingItem, swingHand, swingMainHand, swingOffHand
Methods inherited from interface org.bukkit.loot.Lootable
clearLootTable, getLootTable, getSeed, hasLootTable, 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, getPossibleExperienceReward, getTarget, isAggressive, isAware, isInDaylight, isLeftHanded, lookAt, lookAt, lookAt, lookAt, lookAt, lookAt, setAggressive, setAware, setLeftHanded, setLootTable, 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
-
getVariant
Deprecated.different variants are different classesGets 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
Horse.Variant
representing the horse's variant
-
setVariant
Deprecated.you are required to spawn a different entity- Parameters:
variant
- variant
-
getDomestication
int 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
-
setDomestication
void 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:
level
- domestication level
-
getMaxDomestication
int 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
-
setMaxDomestication
void 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:
level
- the max domestication level
-
getJumpStrength
double 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
-
setJumpStrength
void 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:
strength
- jump strength for this horse
-
isEatingHaystack
Deprecated.useisEatingGrass()
, this name is incorrectGets whether the horse is currently grazing hay.- Returns:
- true if eating hay
-
setEatingHaystack
Deprecated.usesetEatingGrass(boolean)
, this name is incorrectSets whether the horse is grazing hay.- Parameters:
eatingHaystack
- new hay grazing status
-
getInventory
Description copied from interface:InventoryHolder
Get the object's inventory.- Specified by:
getInventory
in interfaceInventoryHolder
- Returns:
- The inventory.
-
isEatingGrass
boolean isEatingGrass()Gets if a horse is in their eating grass animation.- Returns:
- eating grass animation is active
-
setEatingGrass
void setEatingGrass(boolean eating) Sets if a horse is in their eating grass animation.When true, the horse will lower its neck.
- Parameters:
eating
- eating grass animation is active
-
isRearing
boolean isRearing()Gets if a horse is in their rearing animation.- Returns:
- rearing animation is active
-
setRearing
void setRearing(boolean rearing) Sets if a horse is in their rearing animation.When true, the horse will stand on its hind legs.
- Parameters:
rearing
- rearing animation is active
-
isEating
boolean isEating()Gets if a horse is in their eating animation.- Returns:
- eating animation is active
-
setEating
void setEating(boolean eating) Sets if a horse is in their eating animation.When true, the horse will bob its head.
- Parameters:
eating
- eating animation is active
-