org.spongepowered.api.entity.living.animal.Panda Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.entity.living.animal;

import org.spongepowered.api.data.Keys;
import org.spongepowered.api.data.type.PandaGene;
import org.spongepowered.api.data.value.Value;
import org.spongepowered.api.util.Ticks;

/**
 * Represents a Panda.
 */
public interface Panda extends Animal, Sittable {

    /**
     * {@link Keys#KNOWN_GENE}
     *
     * @return Whether this panda has a known gene
     */
    default Value.Mutable knownGene() {
        return this.requireValue(Keys.KNOWN_GENE).asMutable();
    }

    /**
     * {@link Keys#HIDDEN_GENE}
     *
     * @return Whether this panda has a hidden gene
     */
    default Value.Mutable hiddenGene() {
        return this.requireValue(Keys.HIDDEN_GENE).asMutable();
    }

    /**
     * {@link Keys#IS_LYING_ON_BACK}
     *
     * @return The time remaining to lie on it's back
     */
    default Value.Mutable lyingOnBack() {
        return this.requireValue(Keys.IS_LYING_ON_BACK).asMutable();
    }

    /**
     * {@link Keys#IS_ROLLING_AROUND}
     *
     * @return The time remaining to roll around
     */
    default Value.Mutable rollingAround() {
        return this.requireValue(Keys.IS_ROLLING_AROUND).asMutable();
    }

    /**
     * {@link Keys#UNHAPPY_TIME}
     *
     * @return The time remaining to be unhappy
     */
    default Value.Mutable unhappyTime() {
        return this.requireValue(Keys.UNHAPPY_TIME).asMutable();
    }

    /**
     * {@link Keys#IS_UNHAPPY}
     *
     * Being happy or unhappy affects the panda's ability to
     * produce offspring or sit down.
     *
     * When offering the unhappy state in vanilla. If the value is false,
     * the unhappy time will be set to 0. Otherwise 32.
     *
     * @return Whether the panda is unhappy
     */
    default Value.Mutable unhappy() {
        return this.requireValue(Keys.IS_UNHAPPY).asMutable();
    }

    /**
     * {@link Keys#EATING_TIME}
     * @return The eating time
     */
    default Value.Mutable eatingTime() {
        return this.requireValue(Keys.EATING_TIME).asMutable();
    }

    /**
     * {@link Keys#IS_EATING}
     *
     * @return Whether the panda is eating
     */
    default Value.Mutable eating() {
        return this.requireValue(Keys.IS_EATING).asMutable();
    }

    /**
     * {@link Keys#IS_SNEEZING}
     * @return Whether this panda is sneezing
     */
    default Value.Mutable sneezing() {
        return this.requireValue(Keys.IS_SNEEZING).asMutable();
    }

    /**
     * {@link Keys#SNEEZING_TIME}
     * @return The sneezing time
     */
    default Value.Mutable sneezingTime() {
        return this.requireValue(Keys.SNEEZING_TIME).asMutable();
    }

    /**
     * {@link Keys#IS_FRIGHTENED}
     *
     * @return Whether this panda is frightened
     */
    default Value frightened() {
        return this.requireValue(Keys.IS_FRIGHTENED);
    }
}