Merge branch 'main' into docs/plotid

This commit is contained in:
Alexander Brandes 2023-09-13 21:14:10 +02:00 committed by GitHub
commit 2b0c1465c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 6 deletions

View File

@ -25,9 +25,9 @@ import java.util.UUID;
public interface OfflinePlotPlayer extends PermissionHolder { public interface OfflinePlotPlayer extends PermissionHolder {
/** /**
* Gets the {@code UUID} of this player * Returns the UUID of the player.
* *
* @return the player {@link UUID} * @return the UUID of the player
*/ */
UUID getUUID(); UUID getUUID();
@ -39,9 +39,9 @@ public interface OfflinePlotPlayer extends PermissionHolder {
long getLastPlayed(); long getLastPlayed();
/** /**
* Gets the name of this player. * Returns the name of the player.
* *
* @return the player name * @return the name of the player
*/ */
String getName(); String getName();

View File

@ -273,8 +273,9 @@ public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer,
return this.meta == null ? null : this.meta.remove(key); return this.meta == null ? null : this.meta.remove(key);
} }
/** /**
* This player's name. * Returns the name of the player.
* *
* @return the name of the player * @return the name of the player
*/ */

View File

@ -67,14 +67,25 @@ public class PlotItemStack {
return this.type; return this.type;
} }
/**
* Returns the number of items in this stack.
* Valid values range from 1-255.
*
* @return the amount of items in this stack
*/
public int getAmount() { public int getAmount() {
return amount; return amount;
} }
/**
* Returns the given name of this stack of items. The name is displayed when
* hovering over the item.
*
* @return the given name of this stack of items
*/
public String getName() { public String getName() {
return name; return name;
} }
public String[] getLore() { public String[] getLore() {
return lore; return lore;
} }

View File

@ -18,9 +18,25 @@
*/ */
package com.plotsquared.core.plot; package com.plotsquared.core.plot;
/**
* The different types of weather that can be set for a Plot.
*/
public enum PlotWeather { public enum PlotWeather {
/**
* Rainy weather conditions
*/
RAIN, RAIN,
/**
* Clear weather conditions
*/
CLEAR, CLEAR,
/**
* Use the weather of the world the plot is in
*/
WORLD, WORLD,
/**
* Turn off weather for the plot
*/
OFF OFF
} }