CustomNPC-Plus-API/java/noppes/npcs/api/entity/IAnimal.java

package noppes.npcs.api.entity;

import net.minecraft.entity.passive.EntityAnimal;
import noppes.npcs.api.item.IItemStack;

/**
 * Represents an animal entity with additional behavior such as breeding,
 * following, and mating.
 *
 * @param <T> the underlying Minecraft EntityAnimal type.
 */
public interface IAnimal<T extends EntityAnimal> extends IEntityLiving<T> {

    /**
     * Checks whether the specified item can be used to breed this animal.
     * (e.g. wheat, carrots or seeds depending on the animal type)
     *
     * @param itemStack the item to test.
     * @return true if the item is a breeding item; false otherwise.
     */
    boolean isBreedingItem(IItemStack itemStack);

    /**
     * Called when a player interacts with the animal.
     * For example, this might return true if the player milks a cow or saddles a pig.
     *
     * @param player the interacting player.
     * @return true if the interaction was handled; false otherwise.
     */
    boolean interact(IPlayer player);

    /**
     * Sets the specified player as the one to follow.
     *
     * @param player the player to follow.
     */
    void setFollowPlayer(IPlayer player);

    /**
     * Returns the player that this animal is currently following.
     *
     * @return the following player, or null if not following anyone.
     */
    IPlayer followingPlayer();

    /**
     * Checks if the animal is currently in a "love" state,
     * indicating readiness to mate.
     *
     * @return true if the animal is in love; false otherwise.
     */
    boolean isInLove();

    /**
     * Resets the animal's love state.
     */
    void resetInLove();

    /**
     * Checks if this animal can mate with another animal.
     *
     * @param animal the other animal.
     * @return true if mating is possible; false otherwise.
     */
    boolean canMateWith(IAnimal animal);
}