Add worldborders

src/main/java/ch/njol/skript/classes/data/BukkitClasses.java

@@ -27,18 +27,7 @@
 import ch.njol.util.StringUtils;
 import ch.njol.yggdrasil.Fields;
 import io.papermc.paper.world.MoonPhase;
-import org.bukkit.Bukkit;
-import org.bukkit.Chunk;
-import org.bukkit.Difficulty;
-import org.bukkit.FireworkEffect;
-import org.bukkit.GameMode;
-import org.bukkit.GameRule;
-import org.bukkit.Location;
-import org.bukkit.Material;
-import org.bukkit.OfflinePlayer;
-import org.bukkit.Registry;
-import org.bukkit.SoundCategory;
-import org.bukkit.World;
+import org.bukkit.*;
 import org.bukkit.World.Environment;
 import org.bukkit.attribute.Attribute;
 import org.bukkit.block.Biome;
@@ -64,11 +53,7 @@
 import org.bukkit.event.player.PlayerResourcePackStatusEvent.Status;
 import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
 import org.bukkit.event.player.PlayerExpCooldownChangeEvent.ChangeReason;
-import org.bukkit.inventory.BlockInventoryHolder;
-import org.bukkit.inventory.Inventory;
-import org.bukkit.inventory.InventoryHolder;
-import org.bukkit.inventory.ItemFlag;
-import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.*;
 import org.bukkit.metadata.Metadatable;
 import org.bukkit.potion.PotionEffect;
 import org.bukkit.potion.PotionEffectType;
@@ -1568,6 +1553,30 @@ public String toVariableNameString(EnchantmentOffer eo) {
 			);
 		}
 
+		Classes.registerClass(new ClassInfo<>(WorldBorder.class, "worldborder")
+			.user("world ?borders?")
+			.name("World Border")
+			.description("Represents the border of a world or player.")
+			.since("INSERT VERSION")
+			.parser(new Parser<WorldBorder>() {
+				@Override
+				public boolean canParse(ParseContext context) {
+					return false;
+				}
+
+				@Override
+				public String toString(WorldBorder border, int flags) {
+					if (border.getWorld() == null)
+						return "virtual world border";
+					return "world border of world named '" + border.getWorld().getName() + "'";
+				}
+
+				@Override
+				public String toVariableNameString(WorldBorder border) {
+					return toString(border, 0);
+				}
+			})
+			.defaultExpression(new EventValueExpression<>(WorldBorder.class)));
 	}
 
 }

src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java

@@ -20,6 +20,10 @@
 import com.destroystokyo.paper.event.player.PlayerElytraBoostEvent;
 import io.papermc.paper.event.entity.EntityMoveEvent;
 import io.papermc.paper.event.player.*;
+import io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent;
+import io.papermc.paper.event.world.border.WorldBorderBoundsChangeFinishEvent;
+import io.papermc.paper.event.world.border.WorldBorderCenterChangeEvent;
+import io.papermc.paper.event.world.border.WorldBorderEvent;
 import org.bukkit.*;
 import org.bukkit.block.Block;
 import org.bukkit.block.BlockFace;
@@ -1880,6 +1884,28 @@ public Block get(PlayerChangeBeaconEffectEvent event) {
 			EventValues.registerEventValue(PlayerElytraBoostEvent.class, Entity.class, PlayerElytraBoostEvent::getFirework);
 		}
 
+		// === WorldBorderEvents ===
+		if (Skript.classExists("io.papermc.paper.event.world.border.WorldBorderEvent")) {
+			// WorldBorderEvent
+			EventValues.registerEventValue(WorldBorderEvent.class, WorldBorder.class, WorldBorderEvent::getWorldBorder);
+
+			// WorldBorderBoundsChangeEvent
+			EventValues.registerEventValue(WorldBorderBoundsChangeEvent.class, Number.class, WorldBorderBoundsChangeEvent::getNewSize, EventValues.TIME_NOW);
+			EventValues.registerEventValue(WorldBorderBoundsChangeEvent.class, Number.class, WorldBorderBoundsChangeEvent::getOldSize, EventValues.TIME_PAST);
+			EventValues.registerEventValue(WorldBorderBoundsChangeEvent.class, Timespan.class, (event) -> new Timespan(event.getDuration()));
+			EventValues.registerEventValue(WorldBorderBoundsChangeEvent.class, WorldBorder.class, WorldBorderBoundsChangeEvent::getWorldBorder);
+
+			// WorldBorderBoundsChangeFinishEvent
+			EventValues.registerEventValue(WorldBorderBoundsChangeFinishEvent.class, Number.class, WorldBorderBoundsChangeFinishEvent::getNewSize, EventValues.TIME_NOW);
+			EventValues.registerEventValue(WorldBorderBoundsChangeFinishEvent.class, Number.class, WorldBorderBoundsChangeFinishEvent::getOldSize, EventValues.TIME_PAST);
+			EventValues.registerEventValue(WorldBorderBoundsChangeFinishEvent.class, Timespan.class, (event) -> new Timespan((long) event.getDuration()));
+			EventValues.registerEventValue(WorldBorderBoundsChangeFinishEvent.class, WorldBorder.class, WorldBorderBoundsChangeFinishEvent::getWorldBorder);
+
+			// WorldBorderCenterChangeEvent
+			EventValues.registerEventValue(WorldBorderCenterChangeEvent.class, Location.class, WorldBorderCenterChangeEvent::getNewCenter, EventValues.TIME_NOW);
+			EventValues.registerEventValue(WorldBorderCenterChangeEvent.class, Location.class, WorldBorderCenterChangeEvent::getOldCenter, EventValues.TIME_PAST);
+			EventValues.registerEventValue(WorldBorderCenterChangeEvent.class, WorldBorder.class, WorldBorderCenterChangeEvent::getWorldBorder);
+		}
 	}
 
 }

src/main/java/ch/njol/skript/conditions/CondIsWithin.java

@@ -14,6 +14,7 @@
 import org.bukkit.Chunk;
 import org.bukkit.Location;
 import org.bukkit.World;
+import org.bukkit.WorldBorder;
 import org.bukkit.block.Block;
 import org.bukkit.entity.Entity;
 import org.bukkit.event.Event;
@@ -39,12 +40,12 @@
 		"\tcancel event",
 		"\tsend \"Back up!\" to attacker and victim",
 })
-@Since("2.7")
+@Since("2.7, INSERT VERSION (worldborder)")
 @RequiredPlugins("MC 1.17+ (within block)")
 public class CondIsWithin extends Condition {
 
 	static {
-		String validTypes = "entity/chunk/world";
+		String validTypes = "entity/chunk/world/worldborder";
 		if (Skript.methodExists(Block.class, "getCollisionShape"))
 			validTypes += "/block";
 
@@ -71,7 +72,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 			loc1 = (Expression<Location>) exprs[1];
 			loc2 = (Expression<Location>) exprs[2];
 		} else {
-			// within an entity/block/chunk/world
+			// within an entity/block/chunk/world/worldborder
 			withinLocations = false;
 			area = exprs[1];
 		}
@@ -90,7 +91,7 @@ public boolean check(Event event) {
 			return locsToCheck.check(event, box::contains, isNegated());
 		}
 
-		// else, within an entity/block/chunk/world
+		// else, within an entity/block/chunk/world/worldborder
 		Object area = this.area.getSingle(event);
 		if (area == null)
 			return isNegated();
@@ -125,6 +126,11 @@ public boolean check(Event event) {
 			return locsToCheck.check(event, (loc) -> loc.getWorld().equals(area), isNegated());
 		}
 
+		// Worldborders
+		if (area instanceof WorldBorder worldBorder) {
+			return locsToCheck.check(event, worldBorder::isInside, isNegated());
+		}
+
 		// fall-back
 		return false;
 	}

src/main/java/ch/njol/skript/effects/EffWorldBorderExpand.java

@@ -0,0 +1,102 @@
+package ch.njol.skript.effects;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Effect;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.SyntaxStringBuilder;
+import ch.njol.skript.util.Timespan;
+import ch.njol.skript.util.Timespan.TimePeriod;
+import ch.njol.util.Kleenean;
+import ch.njol.util.Math2;
+import org.bukkit.WorldBorder;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Expand/Shrink World Border")
+@Description({
+	"Expand or shrink the size of a world border.",
+	"Note: Using `by` adds/subtracts from the current size of the world border.",
+	"Using `to` sets to the specified size."
+})
+@Examples({
+	"expand world border of player by 100 in 5 seconds",
+	"shrink world border of world \"world\" to 100 in 10 seconds"
+})
+@Since("INSERT VERSION")
+public class EffWorldBorderExpand extends Effect {
+
+	static {
+		Skript.registerEffect(EffWorldBorderExpand.class,
+			"(expand|grow) [(diameter|:radius) of] %worldborders% (by|:to) %number% [over [a period of] %-timespan%]",
+			"(expand|grow) %worldborders%['s (diameter|:radius)] (by|:to) %number% [over [a period of] %-timespan%]",
+			"(contract|shrink) [(diameter|:radius) of] %worldborders% (by|:to) %number% [over [a period of] %-timespan%]",
+			"(contract|shrink) %worldborders%['s (diameter|:radius)] (by|:to) %number% [over [a period of] %-timespan%]"
+
+		);
+	}
+
+	private boolean shrink;
+	private boolean radius;
+	private boolean to;
+	private Expression<WorldBorder> worldBorders;
+	private Expression<Number> number;
+	private @Nullable Expression<Timespan> timespan;
+	private static final double MAX_WORLDBORDER_SIZE = 6.0E7;
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		worldBorders = (Expression<WorldBorder>) exprs[0];
+		number = (Expression<Number>) exprs[1];
+		timespan = (Expression<Timespan>) exprs[2];
+		shrink = matchedPattern > 1;
+		radius = parseResult.hasTag("radius");
+		to = parseResult.hasTag("to");
+		return true;
+	}
+
+	@Override
+	protected void execute(Event event) {
+		double input = number.getOptionalSingle(event).orElse(0).doubleValue();
+		if (radius)
+			input *= 2;
+		long speed = 0;
+		if (timespan != null) {
+			Timespan timespan = this.timespan.getSingle(event);
+			if (timespan != null)
+				speed = timespan.getAs(TimePeriod.SECOND);
+		}
+		WorldBorder[] worldBorders = this.worldBorders.getAll(event);
+		if (to) {
+			for (WorldBorder worldBorder : worldBorders)
+				worldBorder.setSize(Math2.fit(1, input, MAX_WORLDBORDER_SIZE), speed);
+		} else {
+			if (shrink)
+				input = -input;
+			for (WorldBorder worldBorder : worldBorders) {
+				double size = worldBorder.getSize();
+				size = Math2.fit(1, size + input, MAX_WORLDBORDER_SIZE);
+				worldBorder.setSize(size, speed);
+			}
+		}
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		SyntaxStringBuilder builder = new SyntaxStringBuilder(event, debug);
+		builder.append(shrink ? "shrink" : "expand");
+		builder.append(radius ? "radius" : "diameter");
+		builder.append("of", worldBorders);
+		builder.append(to ? "to" : "by");
+		builder.append(number);
+		if (timespan != null)
+			builder.append("over", timespan);
+		return builder.toString();
+	}
+
+}

src/main/java/ch/njol/skript/events/SimpleEvents.java

@@ -15,6 +15,9 @@
 import io.papermc.paper.event.player.PlayerInventorySlotChangeEvent;
 import io.papermc.paper.event.player.PlayerStopUsingItemEvent;
 import io.papermc.paper.event.player.PlayerTradeEvent;
+import io.papermc.paper.event.world.border.WorldBorderBoundsChangeEvent;
+import io.papermc.paper.event.world.border.WorldBorderBoundsChangeFinishEvent;
+import io.papermc.paper.event.world.border.WorldBorderCenterChangeEvent;
 import org.bukkit.event.Event;
 import org.bukkit.event.block.*;
 import org.bukkit.event.enchantment.EnchantItemEvent;
@@ -701,6 +704,41 @@ public class SimpleEvents {
 					.requiredPlugins("Paper");
 		}
 
+		if (Skript.classExists("io.papermc.paper.event.world.border.WorldBorderEvent")) {
+			Skript.registerEvent("World Border Bounds Change", SimpleEvent.class, WorldBorderBoundsChangeEvent.class, "[world[ ]]border [bounds] chang(e|ing)")
+				.description(
+					"Called when a world border changes its bounds, either over time, or instantly.",
+					"Note: event-number will be the diameter of the world border."
+				)
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on border bounds change:",
+						"\tbroadcast \"You better get moving!\""
+				)
+				.since("INSERT VERSION");
+
+			Skript.registerEvent("World Border Bounds Finish Change", SimpleEvent.class, WorldBorderBoundsChangeFinishEvent.class, "[world[ ]]border [bounds] finish chang(e|ing)")
+				.description(
+					"Called when a moving world border has finished its move.",
+					"Note: event-number will be the diameter of the world border."
+				)
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on border bounds finish change:",
+						"\tbroadcast \"Get inside the borders!\""
+				)
+				.since("INSERT VERSION");
+
+			Skript.registerEvent("World Border Center Change", SimpleEvent.class, WorldBorderCenterChangeEvent.class, "[world[ ]]border center chang(e|ing)")
+				.description("Called when a world border's center has changed.")
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on border center change:",
+						"\tbroadcast \"The center has moved\""
+				)
+				.since("INSERT VERSION");
+		}
+
 		if (Skript.classExists("io.papermc.paper.event.player.PlayerChangeBeaconEffectEvent")) {
 			Skript.registerEvent("Beacon Change Effect", SimpleEvent.class, PlayerChangeBeaconEffectEvent.class,
 					"beacon change effect", "beacon effect change", "player chang(e[s]|ing) [of] beacon effect")
@@ -763,6 +801,43 @@ public class SimpleEvents {
 				.since("INSERT VERSION");
 		}
 
+		// WorldBorder Events
+		if (Skript.classExists("io.papermc.paper.event.world.border.WorldBorderEvent")) {
+			Skript.registerEvent("World Border Bounds Change", SimpleEvent.class, WorldBorderBoundsChangeEvent.class, "world[ ]border [bounds] chang(e|ing)")
+				.description(
+					"Called when a world border changes its bounds, either over time, or instantly.",
+					"Note: Does not get called for virtual borders"
+				)
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on worldborder bounds change:",
+						"\tbroadcast \"The border is changing from a diameter of %past event-number% to %event-number% over %event-timespan%\""
+				)
+				.since("INSERT VERSION");
+
+			Skript.registerEvent("World Border Bounds Finish Change", SimpleEvent.class, WorldBorderBoundsChangeFinishEvent.class, "world[ ]border [bounds] finish chang(e|ing)")
+				.description(
+					"Called when a moving world border has finished its move.",
+					"Note: Does not get called for virtual borders"
+				)
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on worldborder bounds finish change:",
+						"\tbroadcast \"Over the past %event-timespan%, the diameter of %event-worldborder% went from %past event-number% to %event-number%\""
+				)
+				.since("INSERT VERSION");
+
+			Skript.registerEvent("World Border Center Change", SimpleEvent.class, WorldBorderCenterChangeEvent.class, "world[ ]border center chang(e|ing)")
+				.description("Called when a world border's center has changed.",
+					"Note: Does not get called for virtual borders"
+				)
+				.requiredPlugins("Paper 1.16+")
+				.examples(
+					"on worldborder center change:",
+						"\tbroadcast \"The center of %event-worldborder% has moved from %past event-location% to %event-location%\""
+				)
+				.since("INSERT VERSION");
+		}
 	}
 
 }