Deprecate Boat API

Boats are complex and the way in which they operate is generally implementation specific. Many of these methods have not worked for several CraftBukkit versions, and are now not guaranteed to work at all due to new internal mechanics.

By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2016-03-01 08:30:03 +11:00
parent 9cd422d56a
commit edc59b54d9

View file

@ -10,14 +10,18 @@ public interface Boat extends Vehicle {
* velocity.
*
* @return The max speed.
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public double getMaxSpeed();
/**
* Sets the maximum speed of a boat. Must be nonnegative. Default is 0.4D.
*
* @param speed The max speed.
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public void setMaxSpeed(double speed);
/**
@ -25,7 +29,9 @@ public interface Boat extends Vehicle {
* boats. The default is 0.2.
*
* @return The rate of deceleration
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public double getOccupiedDeceleration();
/**
@ -34,7 +40,9 @@ public interface Boat extends Vehicle {
* The default is 0.2.
*
* @param rate deceleration rate
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public void setOccupiedDeceleration(double rate);
/**
@ -43,7 +51,9 @@ public interface Boat extends Vehicle {
* deceleration is imposed.
*
* @return The rate of deceleration
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public double getUnoccupiedDeceleration();
/**
@ -53,20 +63,26 @@ public interface Boat extends Vehicle {
* indicate that no additional deceleration is imposed.
*
* @param rate deceleration rate
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public void setUnoccupiedDeceleration(double rate);
/**
* Get whether boats can work on land.
*
* @return whether boats can work on land
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public boolean getWorkOnLand();
/**
* Set whether boats can work on land.
*
* @param workOnLand whether boats can work on land
* @deprecated boats are complex and many of these methods do not work correctly across multiple versions.
*/
@Deprecated
public void setWorkOnLand(boolean workOnLand);
}