Leashable 5.47.0

interface · pocketmine\entity\Leashable · source

An entity a lead can be put on (vanilla minecraft:leashable, see LeashTrait): every Mob, squids, which are WaterAnimals rather than mobs, and boats.

Methods

canBeLeashed()

public function canBeLeashed() : bool

Whether a lead can be put on it.

getLeashHolder()

public function getLeashHolder() : ?\pocketmine\entity\Entity

Returns the player, knot or mob holding the lead, if it is loaded.

isLeashed()

public function isLeashed() : bool

isLeashedTo()

public function isLeashedTo(\pocketmine\entity\Entity $holder) : bool

Whether the given entity holds the lead (or is the saved mob holder not found again yet).

setLeashHolder()

public function setLeashHolder(\pocketmine\entity\Entity $holder) : void

unleash()

public function unleash(bool $dropLead) : void

Removes the lead; it drops as an item if asked.