Newer
Older
ultramine_bukkit / src / main / java / org / bukkit / entity / Minecart.java
@vlad20012 vlad20012 on 24 Feb 2017 2 KB initial
package org.bukkit.entity;

import org.bukkit.util.Vector;

/**
 * Represents a minecart entity.
 */
public interface Minecart extends Vehicle
{

	/**
	 * This method exists for legacy reasons to provide backwards
	 * compatibility. It will not exist at runtime and should not be used
	 * under any circumstances.
	 */
	@Deprecated
	public void _INVALID_setDamage(int damage);

	/**
	 * Sets a minecart's damage.
	 *
	 * @param damage over 40 to "kill" a minecart
	 */
	public void setDamage(double damage);

	/**
	 * This method exists for legacy reasons to provide backwards
	 * compatibility. It will not exist at runtime and should not be used
	 * under any circumstances.
	 */
	@Deprecated
	public int _INVALID_getDamage();

	/**
	 * Gets a minecart's damage.
	 *
	 * @return The damage
	 */
	public double getDamage();

	/**
	 * Gets the maximum speed of a minecart. The speed is unrelated to the
	 * velocity.
	 *
	 * @return The max speed
	 */
	public double getMaxSpeed();

	/**
	 * Sets the maximum speed of a minecart. Must be nonnegative. Default is
	 * 0.4D.
	 *
	 * @param speed The max speed
	 */
	public void setMaxSpeed(double speed);

	/**
	 * Returns whether this minecart will slow down faster without a passenger
	 * occupying it
	 *
	 * @return Whether it decelerates faster
	 */
	public boolean isSlowWhenEmpty();

	/**
	 * Sets whether this minecart will slow down faster without a passenger
	 * occupying it
	 *
	 * @param slow Whether it will decelerate faster
	 */
	public void setSlowWhenEmpty(boolean slow);

	/**
	 * Gets the flying velocity modifier. Used for minecarts that are in
	 * mid-air. A flying minecart's velocity is multiplied by this factor each
	 * tick.
	 *
	 * @return The vector factor
	 */
	public Vector getFlyingVelocityMod();

	/**
	 * Sets the flying velocity modifier. Used for minecarts that are in
	 * mid-air. A flying minecart's velocity is multiplied by this factor each
	 * tick.
	 *
	 * @param flying velocity modifier vector
	 */
	public void setFlyingVelocityMod(Vector flying);

	/**
	 * Gets the derailed velocity modifier. Used for minecarts that are on the
	 * ground, but not on rails.
	 * <p>
	 * A derailed minecart's velocity is multiplied by this factor each tick.
	 *
	 * @return derailed visible speed
	 */
	public Vector getDerailedVelocityMod();

	/**
	 * Sets the derailed velocity modifier. Used for minecarts that are on the
	 * ground, but not on rails. A derailed minecart's velocity is multiplied
	 * by this factor each tick.
	 *
	 * @param derailed visible speed
	 */
	public void setDerailedVelocityMod(Vector derailed);
}