From 665f5251bff7a6a6f2a8f1093011359cb037825d Mon Sep 17 00:00:00 2001 From: Matt <4009945+MattBDev@users.noreply.github.com> Date: Tue, 12 Sep 2023 20:42:58 -0400 Subject: [PATCH 1/4] Added docs to PlotItemStack --- .../com/plotsquared/core/plot/PlotItemStack.java | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Core/src/main/java/com/plotsquared/core/plot/PlotItemStack.java b/Core/src/main/java/com/plotsquared/core/plot/PlotItemStack.java index ea9e5d7de..68ea240dc 100644 --- a/Core/src/main/java/com/plotsquared/core/plot/PlotItemStack.java +++ b/Core/src/main/java/com/plotsquared/core/plot/PlotItemStack.java @@ -67,14 +67,25 @@ public class PlotItemStack { 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() { 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() { return name; } - public String[] getLore() { return lore; } From 764156b267419cedb554b01aa689399ce3591a27 Mon Sep 17 00:00:00 2001 From: Matt <4009945+MattBDev@users.noreply.github.com> Date: Tue, 12 Sep 2023 20:58:24 -0400 Subject: [PATCH 2/4] Minor doc rewrite --- .../com/plotsquared/core/player/OfflinePlotPlayer.java | 8 ++++---- .../main/java/com/plotsquared/core/player/PlotPlayer.java | 3 ++- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/Core/src/main/java/com/plotsquared/core/player/OfflinePlotPlayer.java b/Core/src/main/java/com/plotsquared/core/player/OfflinePlotPlayer.java index 87505b44f..f88f58c7b 100644 --- a/Core/src/main/java/com/plotsquared/core/player/OfflinePlotPlayer.java +++ b/Core/src/main/java/com/plotsquared/core/player/OfflinePlotPlayer.java @@ -25,9 +25,9 @@ import java.util.UUID; 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(); @@ -39,9 +39,9 @@ public interface OfflinePlotPlayer extends PermissionHolder { 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(); diff --git a/Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java b/Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java index 6bb9e1bad..74bb89294 100644 --- a/Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java +++ b/Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java @@ -273,8 +273,9 @@ public abstract class PlotPlayer
implements CommandCaller, OfflinePlotPlayer,
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
*/
From d3dab0d736a3b19298120a3266a8ebc1d3fcd295 Mon Sep 17 00:00:00 2001
From: Matt <4009945+MattBDev@users.noreply.github.com>
Date: Tue, 12 Sep 2023 21:13:04 -0400
Subject: [PATCH 3/4] Added documentation for PlotWeather
---
.../plotsquared/core/plot/PlotWeather.java | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/Core/src/main/java/com/plotsquared/core/plot/PlotWeather.java b/Core/src/main/java/com/plotsquared/core/plot/PlotWeather.java
index 331dc846b..6f4afdf98 100644
--- a/Core/src/main/java/com/plotsquared/core/plot/PlotWeather.java
+++ b/Core/src/main/java/com/plotsquared/core/plot/PlotWeather.java
@@ -18,9 +18,28 @@
*/
package com.plotsquared.core.plot;
+Used to specify the type of weather condition within the world.
+
+
+/**
+ * The different types of weather that can be set for a Plot.
+ */
public enum PlotWeather {
+
+ /**
+ * Rainy weather conditions
+ */
RAIN,
+ /**
+ * Clear weather conditions
+ */
CLEAR,
+ /**
+ * Use the weather of the world the plot is in
+ */
WORLD,
+ /**
+ * Turn off weather for the plot
+ */
OFF
}
From 1aa370d56216d1b0846142a301af7757991c0339 Mon Sep 17 00:00:00 2001
From: Alexander Brandes