org.spongepowered.api.entity.vehicle.minecart.MinecartLike 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
There is a newer version: 9.0.0
/*
 * 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.vehicle.minecart;

import org.spongepowered.api.block.BlockState;
import org.spongepowered.api.data.Keys;
import org.spongepowered.api.data.value.Value;
import org.spongepowered.api.entity.Entity;
import org.spongepowered.math.vector.Vector3d;

import java.util.Optional;

/**
 * An abstract representation of a Minecart.
 */
public interface MinecartLike extends Entity {

    /**
     * {@link Keys#IS_ON_RAIL}
     *
     * @return Whether this minecart is on a rail or not
     */
    default Value.Mutable onRail() {
        return this.requireValue(Keys.IS_ON_RAIL).asMutable();
    }

    /**
     * {@link Keys#POTENTIAL_MAX_SPEED}
     *
     * This differs from {@link Entity#swiftness()} in that its value is
     * affected by the block/rail beneath the cart. However, it is still
     * impacted and limited by the cart's swiftness.
     *
     * @return The potential maximum speed
     */
    default Value.Mutable potentialMaxSpeed() {
        return this.requireValue(Keys.POTENTIAL_MAX_SPEED).asMutable();
    }

    /**
     * {@link Keys#SLOWS_UNOCCUPIED}
     *
     * @return Whether this minecart will slow when unoccupied
     */
    default Value.Mutable slowsUnoccupied() {
        return this.requireValue(Keys.SLOWS_UNOCCUPIED).asMutable();
    }

    /**
     * {@link Keys#AIRBORNE_VELOCITY_MODIFIER}
     *
     * @return The airborne velocity modifier
     */
    default Value.Mutable airborneVelocityModifier() {
        return this.requireValue(Keys.AIRBORNE_VELOCITY_MODIFIER).asMutable();
    }

    /**
     * {@link Keys#DERAILED_VELOCITY_MODIFIER}
     *
     * @return The derailed velocity modifier
     */
    default Value.Mutable derailedVelocityModifier() {
        return this.requireValue(Keys.DERAILED_VELOCITY_MODIFIER).asMutable();
    }
}