Interface Leashable

All Superinterfaces:

Audience, CommandSender, DataComponentView, Entity, HoverEventSource<HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, PersistentDataViewHolder, Pointered, ServerOperator, Sound.Emitter

All Known Subinterfaces:

AbstractCow, AbstractHorse, AbstractNautilus, AbstractSkeleton, AbstractVillager, AcaciaBoat, AcaciaChestBoat, Ageable, Allay, Ambient, Animals, Armadillo, Axolotl, BambooChestRaft, BambooRaft, Bat, Bee, BirchBoat, BirchChestBoat, Blaze, Boat, Bogged, Breedable, Breeze, Camel, CamelHusk, Cat, CaveSpider, CherryBoat, CherryChestBoat, ChestBoat, ChestedHorse, Chicken, Cod, CopperGolem, Cow, Creaking, Creature, Creeper, DarkOakBoat, DarkOakChestBoat, Dolphin, Donkey, Drowned, ElderGuardian, EnderDragon, Enderman, Endermite, Evoker, Fish, Flying, Fox, Frog, Ghast, Giant, GlowSquid, Goat, Golem, Guardian, HappyGhast, Hoglin, Horse, Husk, Illager, Illusioner, IronGolem, JungleBoat, JungleChestBoat, Llama, MagmaCube, MangroveBoat, MangroveChestBoat, Mob, Monster, Mule, MushroomCow, Nautilus, NPC, OakBoat, OakChestBoat, Ocelot, PaleOakBoat, PaleOakChestBoat, Panda, Parched, Parrot, Phantom, Pig, Piglin, PiglinAbstract, PiglinBrute, PigZombie, Pillager, PolarBear, PufferFish, Rabbit, Raider, RangedEntity, Ravager, Salmon, SchoolableFish, Sheep, Shulker, Silverfish, Skeleton, SkeletonHorse, Slime, Sniffer, Snowman, Spellcaster, Spider, SpruceBoat, SpruceChestBoat, Squid, Steerable, Stray, Strider, Tadpole, Tameable, TraderLlama, TropicalFish, Turtle, Vex, Villager, Vindicator, WanderingTrader, Warden, WaterMob, Witch, Wither, WitherSkeleton, Wolf, Zoglin, Zombie, ZombieHorse, ZombieNautilus, ZombieVillager

@NullMarked
public interface Leashable
extends Entity

Represents an entity that can be leashed.

Nested Class Summary

Nested classes/interfaces inherited from interface Entity

Entity.Spigot

Method Summary

Modifier and Type	Method	Description
Entity	getLeashHolder()	Gets the entity that is currently leading this entity.
boolean	isLeashed()	Returns whether the entity is currently leashed.
boolean	setLeashHolder(@Nullable Entity holder)	Sets the leash on this entity to be held by the supplied entity.

Methods inherited from interface Audience

clearResourcePacks, clearTitle, closeDialog, 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, showDialog, showTitle, stopSound, stopSound

Methods inherited from interface CommandSender

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

Methods inherited from interface DataComponentView

getData, getDataOrDefault, hasData

Methods inherited from interface 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, getPickItemStack, getPistonMoveReaction, getPitch, getPortalCooldown, getPose, getRider, getScheduler, getScoreboardEntryName, getScoreboardTags, getServer, getSpawnCategory, getSwimHighSpeedSplashSound, getSwimSound, getSwimSplashSound, getTicksLived, getTrackedBy, getTrackedPlayers, getType, getUniqueId, getVehicle, getVelocity, getVisualFire, getWidth, getWorld, getX, getY, getYaw, getZ, hasFixedPose, hasGravity, hasNoPhysics, hasRider, isCustomNameVisible, isDead, isEmpty, isFreezeTickingLocked, isFrozen, isGlowing, isImmuneToFire, isInBubbleColumn, isInDaylight, isInLava, isInPowderedSnow, isInRain, isInsideVehicle, isInvisible, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isInWorld, isOnGround, isPersistent, isRidable, isRidableInWater, isSilent, isSneaking, isTicking, isTrackedBy, isUnderWater, isValid, isVisibleByDefault, isVisualFire, leaveVehicle, lockFreezeTicks, lookAt, lookAt, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setFreezeTicks, setGlowing, setGravity, setImmuneToFire, setInvisible, setInvulnerable, setLastDamageCause, setNoPhysics, setPassenger, setPersistent, setPortalCooldown, setPose, setPose, setRotation, setSilent, setSneaking, setTicksLived, setVelocity, setVisibleByDefault, setVisualFire, setVisualFire, spawnAt, spawnAt, spigot, teamDisplayName, teleport, teleport, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync, teleportAsync, teleportAsync, wouldCollideUsing

Methods inherited from interface HoverEventSource

asHoverEvent

Methods inherited from interface Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface Permissible

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

Methods inherited from interface PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface Pointered

get, getOrDefault, getOrDefaultFrom, pointers

Methods inherited from interface ServerOperator

isOp, setOp

Method Details

isLeashed

boolean isLeashed()

Returns whether the entity is currently leashed.

Returns:

whether the entity is leashed

getLeashHolder

Entity getLeashHolder()
               throws IllegalStateException

Gets the entity that is currently leading this entity.

Returns:

the entity holding the leash

Throws:

IllegalStateException - if not currently leashed

setLeashHolder

boolean setLeashHolder(@Nullable Entity holder)

Sets the leash on this entity to be held by the supplied entity.

This method has no effect on players.

Parameters:

holder - the entity to leash this entity to, or null to unleash

Returns:

whether the operation was successful