diff --git a/API/src/main/java/tech/sbdevelopment/mapreflectionapi/api/MapWrapper.java b/API/src/main/java/tech/sbdevelopment/mapreflectionapi/api/MapWrapper.java index 59ff6c7..2d7f9cb 100644 --- a/API/src/main/java/tech/sbdevelopment/mapreflectionapi/api/MapWrapper.java +++ b/API/src/main/java/tech/sbdevelopment/mapreflectionapi/api/MapWrapper.java @@ -18,9 +18,17 @@ package tech.sbdevelopment.mapreflectionapi.api; +/** + * A {@link MapWrapper} wraps one image. + */ public abstract class MapWrapper extends AbstractMapWrapper { protected ArrayImage content; + /** + * Construct a new {@link MapWrapper} + * + * @param image The {@link ArrayImage} to wrap + */ public MapWrapper(ArrayImage image) { this.content = image; } diff --git a/NMS-v1_12_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_12_R1.java b/NMS-v1_12_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_12_R1.java index 0fe0431..f24528d 100644 --- a/NMS-v1_12_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_12_R1.java +++ b/NMS-v1_12_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_12_R1.java @@ -29,6 +29,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +/** + * The {@link MapSender_v1_12_R1} sends the Map packets to players. + */ public class MapSender_v1_12_R1 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_12_R1 { private MapSender_v1_12_R1() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_12_R1 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_12_R1 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_13_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_13_R2.java b/NMS-v1_13_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_13_R2.java index 4eb19fa..d82d5fc 100644 --- a/NMS-v1_13_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_13_R2.java +++ b/NMS-v1_13_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_13_R2.java @@ -29,6 +29,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +/** + * The {@link MapSender_v1_13_R2} sends the Map packets to players. + */ public class MapSender_v1_13_R2 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_13_R2 { private MapSender_v1_13_R2() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_13_R2 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_13_R2 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_14_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_14_R1.java b/NMS-v1_14_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_14_R1.java index 3e7026a..49ebfae 100644 --- a/NMS-v1_14_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_14_R1.java +++ b/NMS-v1_14_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_14_R1.java @@ -29,6 +29,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +/** + * The {@link MapSender_v1_14_R1} sends the Map packets to players. + */ public class MapSender_v1_14_R1 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_14_R1 { private MapSender_v1_14_R1() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_14_R1 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_14_R1 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_15_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_15_R1.java b/NMS-v1_15_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_15_R1.java index ea6ee7b..a7b83d9 100644 --- a/NMS-v1_15_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_15_R1.java +++ b/NMS-v1_15_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_15_R1.java @@ -29,6 +29,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +/** + * The {@link MapSender_v1_15_R1} sends the Map packets to players. + */ public class MapSender_v1_15_R1 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_15_R1 { private MapSender_v1_15_R1() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_15_R1 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_15_R1 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_16_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_16_R3.java b/NMS-v1_16_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_16_R3.java index f188e64..e4ed5cf 100644 --- a/NMS-v1_16_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_16_R3.java +++ b/NMS-v1_16_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_16_R3.java @@ -29,6 +29,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +/** + * The {@link MapSender_v1_16_R3} sends the Map packets to players. + */ public class MapSender_v1_16_R3 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_16_R3 { private MapSender_v1_16_R3() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_16_R3 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_16_R3 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_17_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_17_R1.java b/NMS-v1_17_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_17_R1.java index 357e75d..050df5b 100644 --- a/NMS-v1_17_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_17_R1.java +++ b/NMS-v1_17_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_17_R1.java @@ -29,6 +29,9 @@ import tech.sbdevelopment.mapreflectionapi.api.ArrayImage; import java.util.ArrayList; import java.util.List; +/** + * The {@link MapSender_v1_17_R1} sends the Map packets to players. + */ public class MapSender_v1_17_R1 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_17_R1 { private MapSender_v1_17_R1() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_17_R1 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_17_R1 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_18_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_18_R2.java b/NMS-v1_18_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_18_R2.java index b71caa4..ebe34fe 100644 --- a/NMS-v1_18_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_18_R2.java +++ b/NMS-v1_18_R2/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_18_R2.java @@ -29,6 +29,9 @@ import tech.sbdevelopment.mapreflectionapi.api.ArrayImage; import java.util.ArrayList; import java.util.List; +/** + * The {@link MapSender_v1_18_R2} sends the Map packets to players. + */ public class MapSender_v1_18_R2 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_18_R2 { private MapSender_v1_18_R2() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_18_R2 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_18_R2 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_19_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_19_R3.java b/NMS-v1_19_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_19_R3.java index 6714141..50d5bbd 100644 --- a/NMS-v1_19_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_19_R3.java +++ b/NMS-v1_19_R3/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_19_R3.java @@ -29,6 +29,9 @@ import tech.sbdevelopment.mapreflectionapi.api.ArrayImage; import java.util.ArrayList; import java.util.List; +/** + * The {@link MapSender_v1_19_R3} sends the Map packets to players. + */ public class MapSender_v1_19_R3 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_19_R3 { private MapSender_v1_19_R3() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_19_R3 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_19_R3 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>(); diff --git a/NMS-v1_20_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_20_R1.java b/NMS-v1_20_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_20_R1.java index 4bd4140..3f523f7 100644 --- a/NMS-v1_20_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_20_R1.java +++ b/NMS-v1_20_R1/src/main/java/tech/sbdevelopment/mapreflectionapi/nms/MapSender_v1_20_R1.java @@ -29,6 +29,9 @@ import tech.sbdevelopment.mapreflectionapi.api.ArrayImage; import java.util.ArrayList; import java.util.List; +/** + * The {@link MapSender_v1_20_R1} sends the Map packets to players. + */ public class MapSender_v1_20_R1 { private static final List sendQueue = new ArrayList<>(); private static int senderID = -1; @@ -36,6 +39,13 @@ public class MapSender_v1_20_R1 { private MapSender_v1_20_R1() { } + /** + * Add a map to the send queue + * + * @param id The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void addToQueue(final int id, final ArrayImage content, final Player player) { QueuedMap toSend = new QueuedMap(id, content, player); if (sendQueue.contains(toSend)) return; @@ -53,6 +63,9 @@ public class MapSender_v1_20_R1 { sendQueue.removeIf(queuedMap -> queuedMap.id == s); } + /** + * Run the sender task + */ private static void runSender() { if (Bukkit.getScheduler().isQueued(senderID) || Bukkit.getScheduler().isCurrentlyRunning(senderID) || sendQueue.isEmpty()) return; @@ -71,6 +84,13 @@ public class MapSender_v1_20_R1 { }, 0, 2); } + /** + * Send a map to a player + * + * @param id0 The ID of the map + * @param content The {@link ArrayImage} to view on the map + * @param player The {@link Player} to view for + */ public static void sendMap(final int id0, final ArrayImage content, final Player player) { if (player == null || !player.isOnline()) { List toRemove = new ArrayList<>();