Minor javadoc updates

This commit is contained in:
MattBDev 2019-04-22 11:45:23 -04:00
parent 0c0d0104d7
commit f5fa15080c
2 changed files with 12 additions and 7 deletions

View File

@ -5,28 +5,29 @@ import java.util.UUID;
public interface OfflinePlotPlayer {
/**
* Get the {@code UUID} of this player
* Gets the {@code UUID} of this player
*
* @return the player {@link UUID}
*/
UUID getUUID();
/**
* Get the time in milliseconds when the player was last seen online.
* Gets the time in milliseconds when the player was last seen online.
*
* @return the time in milliseconds when last online
* @deprecated This method may be inconsistent across platforms. The javadoc may be wrong depending on which platform is used.
*/
long getLastPlayed();
@SuppressWarnings("DeprecatedIsStillUsed") @Deprecated long getLastPlayed();
/**
* Checks if this player is online.
*
* @return true if this player is online
* @return {@code true} if this player is online
*/
boolean isOnline();
/**
* Get the name of this player.
* Gets the name of this player.
*
* @return the player name
*/

View File

@ -426,12 +426,16 @@ public abstract class PlotPlayer implements CommandCaller, OfflinePlotPlayer {
*/
public abstract void setTime(long time);
/**
* Determines whether or not the player can fly.
* @return {@code true} if the player is allowed to fly
*/
public abstract boolean getFlight();
/**
* Set this player's fly mode.
* Sets whether or not this player can fly.
*
* @param fly if the player can fly
* @param fly {@code true} if the player can fly, otherwise {@code false}
*/
public abstract void setFlight(boolean fly);