Add server broadcast event

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

@@ -104,6 +104,7 @@
 import org.bukkit.event.player.PlayerToggleFlightEvent;
 import org.bukkit.event.player.PlayerToggleSneakEvent;
 import org.bukkit.event.player.PlayerToggleSprintEvent;
+import org.bukkit.event.server.BroadcastMessageEvent;
 import org.bukkit.event.server.ServerListPingEvent;
 import org.bukkit.event.vehicle.VehicleCreateEvent;
 import org.bukkit.event.vehicle.VehicleDamageEvent;
@@ -118,9 +119,6 @@
 import org.bukkit.event.world.PortalCreateEvent;
 import org.bukkit.event.world.SpawnChangeEvent;
 
-/**
- * @author Peter Güttinger
- */
 public class SimpleEvents {
 	static {
 		Skript.registerEvent("Can Build Check", SimpleEvent.class, BlockCanBuildEvent.class, "[block] can build check")
@@ -744,12 +742,21 @@ public class SimpleEvents {
 				.description("Called when a player drags an item in their cursor across the inventory.")
 				.examples(
 						"on inventory drag:",
-						"\tif player's current inventory is {_gui}:",
-						"\t\tsend \"You can't drag your items here!\" to player",
-						"\t\tcancel event"
+							"\tif player's current inventory is {inventories::custom-gui}:",
+							"\t\tsend \"You can't drag your items here!\" to player",
+							"\t\tcancel event"
 				)
 				.since("2.7");
 
+		Skript.registerEvent("Server Broadcast", SimpleEvent.class, BroadcastMessageEvent.class, "[server] broadcast")
+				.description("Called when the server broadcasts messages. Does not get called when using Skript's <a href='effects.html#EffBroadcast'>broadcast</a> effect.")
+				.examples(
+						"on server broadcast:",
+							"\tbroadcast-message contains \"example\"",
+							"\tcancel event"
+				)
+				.since("INSERT VERSION");
+
 		if (Skript.classExists("org.bukkit.event.entity.PiglinBarterEvent")) {
 			Skript.registerEvent("Piglin Barter", SimpleEvent.class, PiglinBarterEvent.class, "piglin (barter[ing]|trad(e|ing))")
 				.requiredPlugins("Minecraft 1.16+")
@@ -764,6 +771,7 @@ public class SimpleEvents {
 				)
 				.since("INSERT VERSION");
 		}
+
 		{
 			final Class<? extends Event> eventClass;
 			if (Skript.classExists("org.bukkit.event.block.BellRingEvent")) {

src/main/java/ch/njol/skript/expressions/ExprChatRecipients.java

@@ -18,11 +18,11 @@
  */
 package ch.njol.skript.expressions;
 
-import java.util.Set;
-
+import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import org.bukkit.event.Event;
 import org.bukkit.event.player.AsyncPlayerChatEvent;
+import org.bukkit.event.server.BroadcastMessageEvent;
 import org.eclipse.jdt.annotation.Nullable;
 
 import ch.njol.skript.Skript;
@@ -40,71 +40,68 @@
 import ch.njol.util.coll.CollectionUtils;
 
 @Name("Chat Recipients")
-@Description("Recipients of chat events where this is called.")
+@Description("Recipients of chat/broadcast events where this is called.")
 @Examples("chat recipients")
-@Since("2.2-Fixes-v7, 2.2-dev35 (clearing recipients)")
-public class ExprChatRecipients extends SimpleExpression<Player> {
+@Since("2.2-Fixes-v7, 2.2-dev35 (clearing recipients), INSERT VERSION (broadcast event)")
+public class ExprChatRecipients extends SimpleExpression<CommandSender> {
 
 	static {
-		Skript.registerExpression(ExprChatRecipients.class, Player.class, ExpressionType.SIMPLE, "[chat][( |-)]recipients");
-	}
-
-	@Override
-	public boolean isSingle() {
-		return false;
-	}
-
-	@Override
-	public Class<Player> getReturnType() {
-		return Player.class;
-	}
-
-	@Override
-	public Class<?>[] acceptChange(final ChangeMode mode) {
-		return CollectionUtils.array(Player[].class);
+		Skript.registerExpression(ExprChatRecipients.class, CommandSender.class, ExpressionType.SIMPLE, "[chat( |-)]recipients");
 	}
 
 	@Override
 	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
-		if (!(getParser().isCurrentEvent(AsyncPlayerChatEvent.class))) {
-			Skript.error("Cannot use chat recipients expression outside of a chat event", ErrorQuality.SEMANTIC_ERROR);
+		if (!(getParser().isCurrentEvent(AsyncPlayerChatEvent.class, BroadcastMessageEvent.class))) {
+			Skript.error("Cannot use chat recipients expression outside of a chat or a server broadcast event");
 			return false;
 		}
 		return true;
 	}
 
 	@Override
-	public String toString(@Nullable Event event, boolean debug) {
-		return "chat recipients";
+	@Nullable
+	protected CommandSender[] get(Event event) {
+		if (event instanceof AsyncPlayerChatEvent async) {
+			return async.getRecipients().toArray(new Player[0]);
+		} else if (event instanceof BroadcastMessageEvent broadcast) {
+			return broadcast.getRecipients().toArray(new CommandSender[0]);
+		}
+		return null;
 	}
 
 	@Override
-	@Nullable
-	protected Player[] get(Event event) {
-		if (!(event instanceof AsyncPlayerChatEvent))
-			return null;
-
-		AsyncPlayerChatEvent ae = (AsyncPlayerChatEvent) event;
-		Set<Player> playerSet = ae.getRecipients();
-		return playerSet.toArray(new Player[playerSet.size()]);
+	public Class<?>[] acceptChange(ChangeMode mode) {
+		return CollectionUtils.array(CommandSender[].class);
 	}
 
 	@Override
 	public void change(Event event, @Nullable Object[] delta, ChangeMode mode) {
-		if (!(event instanceof AsyncPlayerChatEvent))
+		if (!(event instanceof AsyncPlayerChatEvent) && !(event instanceof BroadcastMessageEvent))
 			return;
 
-		final Player[] recipients = (Player[]) delta;
+		CommandSender[] recipients = (CommandSender[]) delta;
 		switch (mode) {
 			case REMOVE:
 				assert recipients != null;
-				for (Player player : recipients)
-					((AsyncPlayerChatEvent) event).getRecipients().remove(player);
+				if (event instanceof AsyncPlayerChatEvent) {
+					for (CommandSender sender : recipients)
+						((AsyncPlayerChatEvent) event).getRecipients().remove(sender);
+				} else {
+					for (CommandSender sender : recipients)
+						((BroadcastMessageEvent) event).getRecipients().remove(sender);
+				}
 				break;
 			case ADD:
 				assert recipients != null;
-				for (Player player : recipients)
-					((AsyncPlayerChatEvent) event).getRecipients().add(player);
+				if (event instanceof AsyncPlayerChatEvent) {
+					for (CommandSender sender : recipients) {
+						if (sender instanceof Player)
+							((AsyncPlayerChatEvent) event).getRecipients().add((Player) sender);
+					}
+				} else {
+					for (CommandSender sender : recipients)
+						((BroadcastMessageEvent) event).getRecipients().add(sender);
+				}
 				break;
 			case SET:
 				change(event, delta, ChangeMode.DELETE);
@@ -113,8 +110,28 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) {
 			case REMOVE_ALL:
 			case RESET:
 			case DELETE:
-				((AsyncPlayerChatEvent) event).getRecipients().clear();
+				if (event instanceof AsyncPlayerChatEvent) {
+					((AsyncPlayerChatEvent) event).getRecipients().clear();
+				} else {
+					((BroadcastMessageEvent) event).getRecipients().clear();
+				}
 				break;
 		}
 	}
+
+	@Override
+	public boolean isSingle() {
+		return false;
+	}
+
+	@Override
+	public Class<CommandSender> getReturnType() {
+		return CommandSender.class;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return "chat recipients";
+	}
+
 }