SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
paper-api/src/main/java/org/bukkit/entity/Minecart.java
View File

@@ -8,9 +8,9 @@ import org.bukkit.util.Vector;
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.
* 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);
@@ -23,9 +23,9 @@ public interface Minecart extends Vehicle {
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.
* 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();
@@ -38,51 +38,58 @@ public interface Minecart extends Vehicle {
public double getDamage();
/**
* Gets the maximum speed of a minecart. The speed is unrelated to the velocity.
* 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.
* 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
* 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
* 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.
* 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.
* 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.
* 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.
*
@@ -91,8 +98,9 @@ public interface Minecart extends Vehicle {
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.
* 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
*/