Package org.spongepowered.api.entity.living.animal

Interface Animal

All Superinterfaces:

Ageable, Agent, ArmorEquipable, AttributeHolder, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, Entity, EntityProjectileSource, Equipable, HoverEventSource<HoverEvent.ShowEntity>, Identifiable, Living, Locatable, ProjectileSource, RandomProvider, SerializableDataHolder, SerializableDataHolder.Mutable, Sound.Emitter, TeamMember, ValueContainer

All Known Subinterfaces:

Bee, Cat, Chicken, Cow, Donkey, Fox, Horse, HorseLike, Llama, LlamaLike, Mooshroom, Mule, Ocelot, PackHorse, Panda, Parrot, Pig, PolarBear, Rabbit, Sheep, SkeletonHorse, TameableAnimal, TameableHorse, TraderLlama, Turtle, Wolf, ZombieHorse

public interface Animal
extends Ageable

Represents an animal, such as a Cow.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default Optional<Value.Mutable<UUID>>	breeder()	Keys.BREEDER
void	breedWith(Animal animal)	Instructs this animal to breed with the provided animal.
boolean	canBreedWith(Animal other)	Determines if this animal can be bred with the provided animal.
boolean	isFood(ItemStack stack)	Determines if the ItemStack is considered to be food by this animal.

Methods inherited from interface org.spongepowered.api.entity.living.Ageable

adult, babyTicks, breedingCooldown, canBreed

Methods inherited from interface org.spongepowered.api.entity.living.Agent

aiEnabled, dominantHand, goal, leashHolder, persistent, targetEntity

Methods inherited from interface org.spongepowered.api.item.inventory.ArmorEquipable

chest, feet, head, itemInHand, itemInHand, legs, setChest, setFeet, setHead, setItemInHand, setItemInHand, setLegs

Methods inherited from interface org.spongepowered.api.entity.attribute.AttributeHolder

attribute, attribute

Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface org.spongepowered.api.entity.Entity

age, asHoverEvent, baseSize, baseVehicle, boundingBox, canSee, copy, createArchetype, createSnapshot, creator, customName, customNameVisible, damage, damage, direction, displayName, eyeHeight, eyePosition, fallDistance, fireImmuneTicks, fireTicks, glowing, gravityAffected, height, invisible, invulnerabilityTicks, invulnerable, isLoaded, isRemoved, isTransient, lookAt, maxAir, nearbyEntities, nearbyEntities, notifier, onGround, passengers, position, remainingAir, remove, rotation, scale, scoreboardTags, setLocation, setLocationAndRotation, setLocationAndRotation, setPosition, setRotation, setScale, setTransform, silent, sneaking, sprinting, swiftness, transferToWorld, transferToWorld, transform, type, vanish, vanishIgnoresCollision, vanishPreventsTargeting, vanishState, vehicle, velocity, wet

Methods inherited from interface org.spongepowered.api.item.inventory.Equipable

canEquip, canEquip, canEquip, canEquip, equip, equip, equipment, equipped, equipped

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

asHoverEvent

Methods inherited from interface org.spongepowered.api.util.Identifiable

uniqueId

Methods inherited from interface org.spongepowered.api.entity.living.Living

absorption, activeItem, bodyRotations, canGrief, chestRotation, elytraFlying, headDirection, headRotation, health, lastAttacker, lastDamageReceived, maxHealth, potionEffects, stuckArrows, walkingSpeed

Methods inherited from interface org.spongepowered.api.world.Locatable

blockPosition, location, serverLocation, world

Methods inherited from interface org.spongepowered.api.projectile.source.ProjectileSource

launchProjectile, launchProjectile, launchProjectile, launchProjectile, launchProjectileTo, launchProjectileTo

Methods inherited from interface org.spongepowered.api.util.RandomProvider

random

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Mutable

setRawData

Methods inherited from interface org.spongepowered.api.scoreboard.TeamMember

teamRepresentation

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Detail

breeder

default Optional<Value.Mutable<UUID>> breeder()

Keys.BREEDER

Returns:

The current breeder of the animal

isFood

boolean isFood(ItemStack stack)

Determines if the ItemStack is considered to be food by this animal.

Parameters:

stack - The stack

Returns:

True if food, false if not

canBreedWith

boolean canBreedWith(Animal other)

Determines if this animal can be bred with the provided animal. In vanilla, two animals can only be breed if they are the same EntityType and are adults.

Parameters:

other - The animal

Returns:

True if can breed with, false if not

breedWith

void breedWith(Animal animal)

Instructs this animal to breed with the provided animal.

Parameters:

animal - The animal to breed with