Additional cleanup

APickledWalrus · APickledWalrus · commit 55f872d758ef · 2025-07-08T12:39:48.000-04:00
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondCanBuildInRegions.java b/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondCanBuildInRegions.java
@@ -5,7 +5,6 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Condition;
 import ch.njol.skript.lang.Expression;
@@ -34,15 +33,16 @@
 			else:
 				set the targeted block to the first argument
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class CondCanBuildInRegions extends Condition {
 
 	public static void register(SyntaxRegistry registry) {
 		registry.register(SyntaxRegistry.CONDITION, SyntaxInfo.builder(CondCanBuildInRegions.class)
 				.supplier(CondCanBuildInRegions::new)
-				.addPatterns(PropertyCondition.getPatterns(PropertyType.BE, "allowed to build (%-directions% %-locations%|[in] %-worldguardregions%)", "players"))
-				.addPatterns(PropertyCondition.getPatterns(PropertyType.CAN, "build (%-directions% %-locations%|[in] %-worldguardregions%)", "players"))
+				.addPatterns(PropertyCondition.getPatterns(PropertyType.BE,
+						"allowed to build (%-directions% %-locations%|[in] %-worldguardregions%)", "players"))
+				.addPatterns(PropertyCondition.getPatterns(PropertyType.CAN,
+						"build (%-directions% %-locations%|[in] %-worldguardregions%)", "players"))
 				.build());
 	}
 
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondIsRegionMemberOwner.java b/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondIsRegionMemberOwner.java
@@ -5,7 +5,6 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Condition;
 import ch.njol.skript.lang.Expression;
@@ -29,7 +28,6 @@
 		message "Welcome back to %region%"
 		message "%player's name% just entered %region%" to the members of the region
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class CondIsRegionMemberOwner extends Condition {
 
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondIsValidRegionId.java b/src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondIsValidRegionId.java
@@ -4,7 +4,6 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import org.skriptlang.skript.registration.SyntaxRegistry;
@@ -20,7 +19,6 @@
 			message "<red>'%text-argument%' is not a valid region ID")
 		# here is where the rest of the command would go :)
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class CondIsValidRegionId extends PropertyCondition<String> {
 
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/effects/EffCreateRegion.java b/src/main/java/org/skriptlang/skriptworldguard/elements/effects/EffCreateRegion.java
@@ -35,16 +35,15 @@
 	"A global region is a region that has no boundaries, meaning it covers the entire world.",
 	"A cuboid region is the traditional WorldGuard region. It has two points to determine the boundaries.",
 	"A polygonal region comprises many points. These points are used to draw a two-dimensional shape." +
-			" Then, with the provided heights, the shape is extended vertically to form the region." +
-			" At least three points must be provided to create a polygonal region.",
-	"NOTE: If you do not specify the world for a region, you must be sure that the locations provided all have the SAME world.",
-	"NOTE: Region IDs are only valid if they contain letters, numbers, underscores, commas, single quotation marks, dashes, pluses, or forward slashes.",
-	"NOTE: If you attempt to create a region in a world where a region with the same id already exists, that region will be replaced."
+		" Then, with the provided heights, the shape is extended vertically to form the region." +
+		" At least three points must be provided to create a polygonal region.",
+	"Note that if you do not specify the world for a region, you must be sure that the locations provided all have the same world.",
+	"Note that Region IDs are only valid if they contain letters, numbers, underscores, commas, single quotation marks, dashes, pluses, or forward slashes.",
+	"Note that if you attempt to create a region in a world where a region with the same ID already exists, that region will be replaced."
 })
 @Example("create a temporary global region named \"temporary_global_region\" in the player's world")
 @Example("create region \"cuboid_region\" in player's world between the location (0, 60, 0) and the location (10, 70, 10)")
 @Example("create a polygonal region named \"polygonal_region\" with a minimum height of 10 and a maximum height of 20 with points {points::*}")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class EffCreateRegion extends Effect {
 
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/events/EvtRegionEnterLeave.java b/src/main/java/org/skriptlang/skriptworldguard/elements/events/EvtRegionEnterLeave.java
@@ -32,12 +32,11 @@ public static void register(SyntaxRegistry registry) {
 						"enter[ing] of " + regionPattern,
 						"region (exit[ing]|leav(e|ing))",
 						"exit[ing] of " + regionPattern)
-				.addDescription("Called when a player enters or leaves a region (or the specified region(s))")
+				.addDescription("Called when a player enters or leaves a region.")
 				.addExample("""
 						on region enter:
 							send "You entered %region%"
 						""")
-				.addRequiredPlugin("WorldGuard 7")
 				.addSince("1.0")
 				.build());
 		EventValues.registerEventValue(RegionEnterLeaveEvent.class, WorldGuardRegion.class, RegionEnterLeaveEvent::getRegion);
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprBlocksInRegion.java b/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprBlocksInRegion.java
@@ -3,26 +3,26 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.PropertyExpression;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.util.Kleenean;
 import com.google.common.collect.Iterators;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.skriptlang.skript.registration.SyntaxRegistry;
 import org.skriptlang.skriptworldguard.worldguard.RegionUtils;
 import org.skriptlang.skriptworldguard.worldguard.WorldGuardRegion;
 import org.bukkit.block.Block;
 import org.bukkit.event.Event;
 
+import java.util.Collections;
 import java.util.Iterator;
 
 @Name("Blocks of Region")
 @Description("An expression that returns all of the blocks in the given regions.")
 @Example("set the blocks of {arena} to air")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class ExprBlocksInRegion extends PropertyExpression<WorldGuardRegion, Block> {
 
@@ -43,9 +43,13 @@ protected Block[] get(Event event, WorldGuardRegion [] regions) {
 	}
 
 	@Override
-	public Iterator<? extends Block> iterator(Event event) {
+	public @NotNull Iterator<? extends Block> iterator(Event event) {
 		//noinspection unchecked
-		return RegionUtils.getRegionBlockIterator((Iterator<WorldGuardRegion>) getExpr().iterator(event));
+		Iterator<WorldGuardRegion> regionIterator = (Iterator<WorldGuardRegion>) getExpr().iterator(event);
+		if (regionIterator == null) {
+			return Collections.emptyIterator();
+		}
+		return RegionUtils.getRegionBlockIterator(regionIterator);
 	}
 
 	@Override
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprMoveType.java b/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprMoveType.java
@@ -4,7 +4,6 @@
 import ch.njol.skript.doc.Events;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.EventValueExpression;
 import com.sk89q.worldguard.session.MoveType;
@@ -19,7 +18,6 @@
 		if the movement type is swimming:
 			message "You have swum into %region%!"
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Events("Region Enter/Leave")
 @Since("1.0")
 public class ExprMoveType extends EventValueExpression<MoveType> {
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegion.java b/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegion.java
@@ -4,7 +4,6 @@
 import ch.njol.skript.doc.Events;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.EventValueExpression;
 import org.jetbrains.annotations.Nullable;
@@ -18,7 +17,6 @@
 	on region enter:
 		send "You have entered %region%"
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Events("Region Enter/Leave")
 @Since("1.0")
 public class ExprRegion extends EventValueExpression<WorldGuardRegion> {
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionMembersOwners.java b/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionMembersOwners.java
@@ -4,7 +4,6 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.expressions.base.PropertyExpression;
 import ch.njol.skript.lang.Expression;
@@ -34,15 +33,14 @@
 	on region enter:
 		message "You have entered %region%. It is owned by %owners of region%."
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class ExprRegionMembersOwners extends PropertyExpression<WorldGuardRegion, Object> {
 
 	public static void register(SyntaxRegistry registry) {
 		registry.register(SyntaxRegistry.EXPRESSION, SyntaxInfo.Expression.builder(ExprRegionMembersOwners.class, Object.class)
 				.priority(DEFAULT_PRIORITY)
-				.addPatterns(getDefaultPatterns("player (members|:owners)", "worldguardregions"))
-				.addPatterns(getDefaultPatterns("(member|:owner) groups", "worldguardregions"))
+				.addPatterns(getPatterns("player (members|:owners)", "worldguardregions"))
+				.addPatterns(getPatterns("(member|:owner) groups", "worldguardregions"))
 				.build());
 	}
 
@@ -59,7 +57,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 	}
 
 	@Override
-	protected Object [] get(Event event, WorldGuardRegion [] regions) {
+	protected Object[] get(Event event, WorldGuardRegion[] regions) {
 		List<DefaultDomain> domains = new ArrayList<>();
 		if (isOwners) {
 			for (WorldGuardRegion region : regions) {
diff --git a/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionsAt.java b/src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionsAt.java
@@ -3,7 +3,6 @@
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Example;
 import ch.njol.skript.doc.Name;
-import ch.njol.skript.doc.RequiredPlugins;
 import ch.njol.skript.doc.Since;
 import ch.njol.skript.lang.Expression;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
@@ -22,7 +21,10 @@
 import java.util.List;
 
 @Name("Regions At")
-@Description("An expression that returns the regions at the given locations")
+@Description({
+	"An expression to obtain the regions at a specific location.",
+	"Note that the regions will be returned in ascending order by priority."
+})
 @Example("""
 	on right click:
 		the clicked block is tagged with minecraft tag "all_signs"
@@ -33,7 +35,6 @@
 		else:
 			message "You are in: %{_regions::*}%."
 	""")
-@RequiredPlugins("WorldGuard 7")
 @Since("1.0")
 public class ExprRegionsAt extends SimpleExpression<WorldGuardRegion> {
 
diff --git a/src/main/java/org/skriptlang/skriptworldguard/worldguard/RegionUtils.java b/src/main/java/org/skriptlang/skriptworldguard/worldguard/RegionUtils.java
@@ -39,15 +39,15 @@ public final class RegionUtils {
 	private RegionUtils() { }
 
 	/**
-	 * A helper method to simplify getting the RegionContainer from WorldGuard.
-	 * @return The RegionContainer from the {@link WorldGuardPlatform}.
+	 * A utility method for obtaining the {@link RegionContainer} from the running {@link WorldGuardPlatform}.
+	 * @return The region container of the active platform.
 	 */
 	public static RegionContainer getRegionContainer() {
 		return WorldGuard.getInstance().getPlatform().getRegionContainer();
 	}
 
 	/**
-	 * A helper method to simplify getting the RegionManager for a world.
+	 * A utility method for obtaining a world's {@link RegionManager}.
 	 * @param world The world to get the RegionManager for.
 	 * @return The RegionManager for the given world, or null if:
 	 * <ul>
@@ -61,7 +61,7 @@ public static RegionContainer getRegionContainer() {
 	}
 
 	/**
-	 * A helper method to simplify getting the regions of a world.
+	 * A utility method for obtaining all of the regions in a world.
 	 * @param world The world to obtain regions of.
 	 * @return The regions of {@code world}.
 	 *  If {@link #getRegionManager(World)} is unavailable, this method returns an empty list.
@@ -78,7 +78,7 @@ public static RegionContainer getRegionContainer() {
 	}
 
 	/**
-	 * A helper method to simplify getting a region in a world.
+	 * A utility method for obtaining a named region in a world.
 	 * @param world The world of the region.
 	 * @param id The ID of the region. This method will perform ID validation.
 	 * @return The region with the given id in the given world, or null if the region does not exist
@@ -102,23 +102,26 @@ public static RegionContainer getRegionContainer() {
 		return new WorldGuardRegion(world, region);
 	}
 
+	/**
+	 * A utility method for obtaining the regions at a specific location.
+	 * @param location The location to search for regions at.
+	 * @return A list of all regions found at {@code location}.
+	 */
 	public static Collection<WorldGuardRegion> getRegionsAt(Location location) {
-		List<WorldGuardRegion> regions = new ArrayList<>();
-
 		World world = location.getWorld();
 		if (world == null) {
-			return regions;
+			return List.of();
 		}
 
 		RegionManager regionManager = getRegionManager(world);
 		if (regionManager == null) {
-			return regions;
+			return List.of();
 		}
 
+		List<WorldGuardRegion> regions = new ArrayList<>();
 		for (ProtectedRegion region : regionManager.getApplicableRegions(BukkitAdapter.asBlockVector(location))) {
 			regions.add(new WorldGuardRegion(world, region));
 		}
-
 		return regions;
 	}
 
@@ -159,15 +162,20 @@ public static boolean canBuild(Player player, WorldGuardRegion... regions) {
 		return regionSet.testState(localPlayer, Flags.BUILD);
 	}
 
-	public static Iterator<Block> getRegionBlockIterator(Iterator<WorldGuardRegion> regionsIterator) {
+	/**
+	 * A utility method for obtaining an iterator over the blocks of multiple regions.
+	 * @param regionIterator An iterator over the regions whose blocks should be iterated over.
+	 * @return An iterator over the blocks of the regions of {@code regionsIterator}.
+	 */
+	public static Iterator<Block> getRegionBlockIterator(Iterator<WorldGuardRegion> regionIterator) {
 		return new Iterator<>() {
 			Iterator<Block> currentBlockIterator = nextIterator();
 
 			private Iterator<Block> nextIterator() {
-				if (!regionsIterator.hasNext()) { // no new blocks, reuse empty iterator
+				if (!regionIterator.hasNext()) { // no new blocks, reuse empty iterator
 					return currentBlockIterator;
 				}
-				WorldGuardRegion region = regionsIterator.next();
+				WorldGuardRegion region = regionIterator.next();
 				World world = region.world();
 				ProtectedRegion protectedRegion = region.region();
 				AbstractRegion adaptedRegion;
