org.spongepowered.api.entity.display.DisplayEntity 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.display;

import org.spongepowered.api.data.Keys;
import org.spongepowered.api.entity.Entity;
import org.spongepowered.api.util.Ticks;
import org.spongepowered.api.util.Transform;

import java.util.Optional;

public interface DisplayEntity extends Entity {

    /**
     * Returns the transform.
     * 
     * Supports interpolation.
     * 
     *
     * @return the transform
     */
    @Override
    default Transform transform() {
        return this.require(Keys.TRANSFORM);
    }

    /**
     * Returns the duration of the interpolation
     *
     * @return the duration of the interpolation
     */
    default Ticks interpolationDuration() {
        return this.require(Keys.INTERPOLATION_DURATION);
    }

    /**
     * Returns the delay to the start of the interpolation
     *
     * @return the delay to the start of the interpolation
     */
    default Ticks interpolationDelay() {
        return this.require(Keys.INTERPOLATION_DELAY);
    }

    /**
     * Returns the duration of the teleportation
     *
     * @return the duration of the teleportation
     */
    default Ticks teleportDuration() {
        return this.require(Keys.TELEPORT_DURATION);
    }

    default BillboardType billboardType() {
        return this.require(Keys.BILLBOARD_TYPE);
    }

    /**
     * Returns the skylight override.
     *
     * @return the skylight override
     */
    default Optional skyLight() {
        return this.get(Keys.SKY_LIGHT);
    }

    /**
     * Returns the blocklight override.
     *
     * @return the blocklight override
     */
    default Optional blockLight() {
        return this.get(Keys.BLOCK_LIGHT);
    }


    /**
     * Returns the shadow radius.
     *
     * @return the shadow radius.
     */
    default Double shadowRadius() {
        return this.require(Keys.SHADOW_RADIUS);
    }

    /**
     * Returns the shadow strength or darkness.
     * Vanilla defaults to 1
     *
     * @return the shadow strength.
     */
    default Double shadowStrength() {
        return this.require(Keys.SHADOW_STRENGTH);
    }


    /**
     * Returns the range at which the display entity is rendered.
     *
     * @return the view range
     */
    default Double viewRange() {
        return this.require(Keys.VIEW_RANGE);
    }

    // TODO bounding box (maybe BASE_SIZE if this is not smth. else in the entity)
    // TODO glow_color_override -1 = use team color

}