Improve utility organization, region sorting

Author: APickledWalrus

src/main/java/org/skriptlang/skriptworldguard/SkriptWorldGuard.java

@@ -129,7 +129,7 @@ protected WorldGuardRegion deserialize(Fields fields) throws StreamCorruptedExce
 						}
 						WorldGuardRegion region = RegionUtils.getRegion(world, id);
 						if (region == null) {
-							throw new StreamCorruptedException("The " + RegionUtils.toString(world, id) + " from WorldGuard could not be found. Does it still exist?");
+							throw new StreamCorruptedException("The " + WorldGuardRegion.toString(world, id) + " from WorldGuard could not be found. Does it still exist?");
 						}
 						return region;
 					}

src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionsAt.java

@@ -63,6 +63,7 @@ protected WorldGuardRegion[] get(Event event) {
 		for (Location location : locations) {
 			regions.addAll(RegionUtils.getRegionsAt(location));
 		}
+		regions.sort(WorldGuardRegion::compareTo);
 		return regions.toArray(new WorldGuardRegion[0]);
 	}
 

src/main/java/org/skriptlang/skriptworldguard/worldguard/RegionUtils.java

@@ -30,7 +30,34 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-public class RegionUtils {
+/**
+ * Utility methods for working with {@link WorldGuardRegion}s.
+ */
+public final class RegionUtils {
+
+	private RegionUtils() { }
+
+	/**
+	 * A helper method to simplify getting the RegionContainer from WorldGuard.
+	 * @return The RegionContainer from the {@link WorldGuardPlatform}.
+	 */
+	public static RegionContainer getRegionContainer() {
+		return WorldGuard.getInstance().getPlatform().getRegionContainer();
+	}
+
+	/**
+	 * A helper method to simplify getting the RegionManager for a world.
+	 * @param world The world to get the RegionManager for.
+	 * @return The RegionManager for the given world, or null if:
+	 * <ul>
+	 *     <li>Region data for the given world has not been loaded</li>
+	 *     <li>Region data for the given world has failed to load</li>
+	 *     <li>Support for regions has been disabled</li>
+	 * </ul>
+	 */
+	public static @Nullable RegionManager getRegionManager(World world) {
+		return getRegionContainer().get(BukkitAdapter.adapt(world));
+	}
 
 	/**
 	 * A helper method to simplify getting a region in a world.
@@ -157,38 +184,4 @@ public Block next() {
 		};
 	}
 
-	/**
-	 * A helper method to provide a standardized way to stringify a {@link ProtectedRegion}.
-	 * @param world The world of a region.
-	 * @param id The ID of a region.
-	 * @return A stringified version of a region.
-	 * @see WorldGuardRegion#toString()
-	 */
-	public static String toString(World world, String id) {
-		return "region \"" + id + "\" in the world \"" + world.getName() + "\"";
-	}
-
-	/**
-	 * A helper method to simplify getting the RegionContainer from WorldGuard.
-	 * @return The RegionContainer from the {@link WorldGuardPlatform}.
-	 */
-	public static RegionContainer getRegionContainer() {
-		return WorldGuard.getInstance().getPlatform().getRegionContainer();
-	}
-
-	/**
-	 * A helper method to simplify getting the RegionManager for a world.
-	 * @param world The world to get the RegionManager for.
-	 * @return The RegionManager for the given world, or null if:
-	 * <ul>
-	 *     <li>Region data for the given world has not been loaded</li>
-	 *     <li>Region data for the given world has failed to load</li>
-	 *     <li>Support for regions has been disabled</li>
-	 * </ul>
-	 */
-	@Nullable
-	public static RegionManager getRegionManager(World world) {
-		return WorldGuard.getInstance().getPlatform().getRegionContainer().get(BukkitAdapter.adapt(world));
-	}
-
 }

src/main/java/org/skriptlang/skriptworldguard/worldguard/WorldGuardRegion.java

@@ -6,14 +6,27 @@
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import org.bukkit.Location;
 import org.bukkit.World;
+import org.jetbrains.annotations.NotNull;
 import org.skriptlang.skript.lang.converter.Converters;
 
 /**
  * A utility record for associating a {@link ProtectedRegion} with a {@link World}.
  * @param world The world {@code region} is within.
  * @param region WorldGuard region.
  */
-public record WorldGuardRegion(World world, ProtectedRegion region) implements AnyNamed, AnyContains<Object> {
+public record WorldGuardRegion(World world, ProtectedRegion region)
+		implements Comparable<WorldGuardRegion>, AnyNamed, AnyContains<Object> {
+
+	/**
+	 * A helper method to provide a standardized way to stringify a {@link WorldGuardRegion} from its components.
+	 * @param world The world of a region.
+	 * @param id The ID of a region.
+	 * @return A stringified version of a region.
+	 * @see WorldGuardRegion#toString()
+	 */
+	public static String toString(World world, String id) {
+		return "region \"" + id + "\" in the world \"" + world.getName() + "\"";
+	}
 
 	@Override
 	public boolean equals(Object other) {
@@ -25,7 +38,16 @@ public boolean equals(Object other) {
 
 	@Override
 	public String toString() {
-		return RegionUtils.toString(world, region.getId());
+		return toString(world, region.getId());
+	}
+
+	/*
+	 * Comparable
+	 */
+
+	@Override
+	public int compareTo(@NotNull WorldGuardRegion other) {
+		return Integer.compare(this.region.getPriority(), other.region.getPriority());
 	}
 
 	/*