org.bukkit.entity

Interface Tameable

All Superinterfaces:

Ageable, Animals, Attributable, net.kyori.adventure.audience.Audience, Breedable, CommandSender, Creature, Damageable, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, LivingEntity, Lootable, Metadatable, Mob, Nameable, Permissible, PersistentDataHolder, ProjectileSource, ServerOperator

All Known Subinterfaces:

AbstractHorse, Cat, ChestedHorse, Donkey, Horse, Llama, Mule, Parrot, SkeletonHorse, TraderLlama, Wolf, ZombieHorse

public interface Tameable
extends Animals

Nested Class Summary

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

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
@Nullable AnimalTamer	getOwner() Gets the current owning AnimalTamer
UUID	getOwnerUniqueId() Gets the owners UUID
boolean	isTamed() Check if this is tamed
void	setOwner(@Nullable AnimalTamer tamer) Set this to be owned by given AnimalTamer.
void	setTamed(boolean tame) Sets if this has been tamed.

Methods inherited from interface org.bukkit.entity.Animals

getBreedCause, getLoveModeTicks, isLoveMode, setBreedCause, setLoveModeTicks

Methods inherited from interface org.bukkit.entity.Breedable

canBreed, getAgeLock, setAgeLock, setBreed

Methods inherited from interface org.bukkit.entity.Ageable

getAge, isAdult, setAdult, setAge, setBaby

Methods inherited from interface org.bukkit.entity.Mob

getPathfinder, getTarget, isAware, isInDaylight, setAware, setTarget

Methods inherited from interface org.bukkit.entity.LivingEntity

addPotionEffect, addPotionEffect, addPotionEffects, attack, clearActiveItem, getActiveItem, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getArrowsStuck, getCanPickupItems, getCategory, getCollidableExemptions, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getHandRaisedTime, getHurtDirection, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, hasAI, hasLineOfSight, hasPotionEffect, isCollidable, isGliding, isHandRaised, isInvisible, isJumping, isLeashed, isRiptiding, isSleeping, isSwimming, playAnimation, playPickupItemAnimation, playPickupItemAnimation, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setArrowsStuck, setCanPickupItems, setCollidable, setGliding, setHurtDirection, setInvisible, setJumping, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setShieldBlockingDelay, setSwimming, swingMainHand, swingOffHand

Methods inherited from interface org.bukkit.attribute.Attributable

getAttribute, registerAttribute

Methods inherited from interface org.bukkit.entity.Damageable

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

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

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

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

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

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

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

asHoverEvent, unbox

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

launchProjectile, launchProjectile

Methods inherited from interface org.bukkit.loot.Lootable

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

Method Detail

isTamed

boolean isTamed()

Check if this is tamed

If something is tamed then a player can not tame it through normal methods, even if it does not belong to anyone in particular.

Returns:

true if this has been tamed

setTamed

void setTamed(boolean tame)

Sets if this has been tamed. Not necessary if the method setOwner has been used, as it tames automatically.

If something is tamed then a player can not tame it through normal methods, even if it does not belong to anyone in particular.

Parameters:

tame - true if tame

getOwnerUniqueId

@Nullable
UUID getOwnerUniqueId()

Gets the owners UUID

Returns:

the owners UUID, or null if not owned

getOwner

@Nullable
@Nullable AnimalTamer getOwner()

Gets the current owning AnimalTamer

Returns:

the owning AnimalTamer, or null if not owned

See Also:

Recommended to use UUID version instead of this for performance. This method will cause OfflinePlayer to be loaded from disk if the owner is not online.

setOwner

void setOwner(@Nullable
              @Nullable AnimalTamer tamer)

Set this to be owned by given AnimalTamer.

If the owner is not null, this will be tamed and will have any current path it is following removed. If the owner is set to null, this will be untamed, and the current owner removed.

Parameters:

tamer - the AnimalTamer who should own this