Implement new event, made to move the flag Q from core

src/main/java/org/sgrewritten/stargate/api/event/portal/StargateSendMessagePortalEvent.java

@@ -0,0 +1,45 @@
+package org.sgrewritten.stargate.api.event.portal;
+
+import org.bukkit.entity.Entity;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+import org.sgrewritten.stargate.api.network.portal.Portal;
+
+public class StargateSendMessagePortalEvent extends CancellableStargatePortalEvent {
+    private static HandlerList handlers = new HandlerList();
+    private final MessageType type;
+    private final Entity entity;
+
+    /**
+     * Instantiates a new stargate player event
+     *
+     * @param portal           <p>The portal involved in this stargate event</p>
+     * @param entity <p>The entity receiving the message</p>
+     * @param type  <p>The type of message being sent</p>
+     */
+    public StargateSendMessagePortalEvent(Portal portal, Entity entity, MessageType type) {
+        super(portal);
+        this.type = type;
+        this.entity = entity;
+    }
+
+    public MessageType getType() {
+        return type;
+    }
+
+    public Entity getEntity(){
+        return entity;
+    }
+    @Override
+    public @NotNull HandlerList getHandlers() {
+        return handlers;
+    }
+
+    public static HandlerList getHandlerList(){
+        return StargateSendMessagePortalEvent.handlers;
+    }
+
+    public enum MessageType {
+        DESTROY, DESTINATION_EMPTY, DENY, TELEPORT
+    }
+}

src/main/java/org/sgrewritten/stargate/listener/BlockEventListener.java

@@ -1,5 +1,6 @@
 package org.sgrewritten.stargate.listener;
 
+import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.block.Block;
 import org.bukkit.block.data.Directional;
@@ -36,6 +37,7 @@
 import org.sgrewritten.stargate.Stargate;
 import org.sgrewritten.stargate.api.BlockHandlerResolver;
 import org.sgrewritten.stargate.api.StargateAPI;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.api.gate.GateStructureType;
 import org.sgrewritten.stargate.config.ConfigurationHelper;
 import org.sgrewritten.stargate.api.config.ConfigurationOption;
@@ -54,6 +56,7 @@
 import org.sgrewritten.stargate.api.network.portal.RealPortal;
 import org.sgrewritten.stargate.property.BlockEventType;
 import org.sgrewritten.stargate.util.BlockEventHelper;
+import org.sgrewritten.stargate.util.MessageUtils;
 import org.sgrewritten.stargate.util.NetworkCreationHelper;
 import org.sgrewritten.stargate.util.TranslatableMessageFormatter;
 import org.sgrewritten.stargate.util.portal.PortalCreationHelper;
@@ -103,7 +106,7 @@ public void onBlockBreak(BlockBreakEvent event) {
         if (portal != null) {
             Runnable destroyAction = () -> {
                 String msg = languageManager.getErrorMessage(TranslatableMessage.DESTROY);
-                event.getPlayer().sendMessage(msg);
+                MessageUtils.sendMessageFromPortal(portal,event.getPlayer(),msg,StargateSendMessagePortalEvent.MessageType.DESTROY);
 
                 portal.destroy();
                 Stargate.log(Level.FINE, "Broke portal " + portal.getName());
@@ -123,6 +126,8 @@ public void onBlockBreak(BlockBreakEvent event) {
         if (portalFromIris != null) {
             if (BlockEventType.BLOCK_BREAK.canDestroyPortal()) {
                 String msg = languageManager.getErrorMessage(TranslatableMessage.DESTROY);
+                MessageUtils.sendMessageFromPortal(portalFromIris,event.getPlayer(),msg,StargateSendMessagePortalEvent.MessageType.DESTROY);
+
                 event.getPlayer().sendMessage(msg);
                 portalFromIris.destroy();
                 return;

src/main/java/org/sgrewritten/stargate/listener/PlayerEventListener.java

@@ -17,6 +17,7 @@
 import org.sgrewritten.stargate.Stargate;
 import org.sgrewritten.stargate.action.ConditionalDelayedAction;
 import org.sgrewritten.stargate.action.ConditionalRepeatedTask;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.config.ConfigurationHelper;
 import org.sgrewritten.stargate.api.config.ConfigurationOption;
 import org.sgrewritten.stargate.exception.database.StorageWriteException;
@@ -30,6 +31,7 @@
 import org.sgrewritten.stargate.api.network.portal.PortalPosition;
 import org.sgrewritten.stargate.property.PluginChannel;
 import org.sgrewritten.stargate.util.ButtonHelper;
+import org.sgrewritten.stargate.util.MessageUtils;
 import org.sgrewritten.stargate.util.colors.ColorConverter;
 
 import java.io.ByteArrayOutputStream;
@@ -136,7 +138,8 @@ private boolean dyePortalSignText(PlayerInteractEvent event, RealPortal portal)
         StargatePermissionManager permissionManager = new StargatePermissionManager(event.getPlayer(), languageManager);
         boolean hasPermission = permissionManager.hasCreatePermissions(portal);
         if (!hasPermission) {
-            event.getPlayer().sendMessage(permissionManager.getDenyMessage());
+            String message = permissionManager.getDenyMessage();
+            MessageUtils.sendMessageFromPortal(portal,event.getPlayer(),message,StargateSendMessagePortalEvent.MessageType.DENY);
         }
         return hasPermission;
     }

src/main/java/org/sgrewritten/stargate/network/portal/AbstractPortal.java

@@ -44,6 +44,7 @@
 import org.sgrewritten.stargate.api.permission.BypassPermission;
 import org.sgrewritten.stargate.property.NonLegacyMethod;
 import org.sgrewritten.stargate.util.ExceptionHelper;
+import org.sgrewritten.stargate.util.MessageUtils;
 import org.sgrewritten.stargate.util.NameHelper;
 import org.sgrewritten.stargate.util.portal.PortalHelper;
 
@@ -367,14 +368,15 @@ public void onButtonClick(PlayerInteractEvent event) {
 
         Portal destination = getDestination();
         if (destination == null) {
-            player.sendMessage(languageManager.getErrorMessage(TranslatableMessage.INVALID));
+            String message = languageManager.getErrorMessage(TranslatableMessage.INVALID);
+            MessageUtils.sendMessageFromPortal(this,event.getPlayer(),message,StargateSendMessagePortalEvent.MessageType.DESTINATION_EMPTY);
             return;
         }
         StargatePermissionManager permissionManager = new StargatePermissionManager(player, languageManager);
         StargateOpenPortalEvent stargateOpenEvent = new StargateOpenPortalEvent(player, this, false);
         Bukkit.getPluginManager().callEvent(stargateOpenEvent);
         if (!permissionManager.hasOpenPermissions(this, destination)) {
-            event.getPlayer().sendMessage(permissionManager.getDenyMessage());
+            MessageUtils.sendMessageFromPortal(this,player,permissionManager.getDenyMessage(),StargateSendMessagePortalEvent.MessageType.DENY);
             return;
         }
         if (stargateOpenEvent.isCancelled()) {
@@ -512,7 +514,7 @@ public void onSignClick(PlayerInteractEvent event) {
                 permissionManager.getDenyMessage());
         Bukkit.getPluginManager().callEvent(accessEvent);
         if (accessEvent.getDeny()) {
-            event.getPlayer().sendMessage(accessEvent.getDenyReason());
+            MessageUtils.sendMessageFromPortal(this,event.getPlayer(),accessEvent.getDenyReason(),StargateSendMessagePortalEvent.MessageType.DENY);
             return;
         }
 

src/main/java/org/sgrewritten/stargate/network/portal/NetworkedPortal.java

@@ -5,6 +5,7 @@
 import org.bukkit.event.block.Action;
 import org.bukkit.event.player.PlayerInteractEvent;
 import org.sgrewritten.stargate.Stargate;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.api.network.portal.Portal;
 import org.sgrewritten.stargate.api.network.portal.PortalFlag;
 import org.sgrewritten.stargate.api.network.portal.format.*;
@@ -20,6 +21,7 @@
 import org.sgrewritten.stargate.manager.StargatePermissionManager;
 import org.sgrewritten.stargate.api.network.Network;
 import org.sgrewritten.stargate.network.portal.formatting.HighlightingStyle;
+import org.sgrewritten.stargate.util.MessageUtils;
 
 import java.util.*;
 import java.util.logging.Level;
@@ -75,7 +77,8 @@ public void onSignClick(PlayerInteractEvent event) {
         activate(actor);
         if (destinations.size() < 1) {
             String message = super.languageManager.getErrorMessage(TranslatableMessage.DESTINATION_EMPTY);
-            event.getPlayer().sendMessage(message);
+            MessageUtils.sendMessageFromPortal(this,event.getPlayer(),message,StargateSendMessagePortalEvent.MessageType.DESTINATION_EMPTY);
+
             this.isActive = false;
             return;
         }
@@ -275,11 +278,13 @@ private boolean hasActivatePermissions(Player player, StargatePermissionManager
                 permissionManager.getDenyMessage());
         Bukkit.getPluginManager().callEvent(accessEvent);
         if (accessEvent.getDeny()) {
+            String message = null;
             if (accessEvent.getDenyReason() == null) {
-                player.sendMessage(super.languageManager.getErrorMessage(TranslatableMessage.ADDON_INTERFERE));
+                message = super.languageManager.getErrorMessage(TranslatableMessage.ADDON_INTERFERE);
             } else if (!accessEvent.getDenyReason().isEmpty()) {
-                player.sendMessage(accessEvent.getDenyReason());
+                message = accessEvent.getDenyReason();
             }
+            MessageUtils.sendMessageFromPortal(this,player,message,StargateSendMessagePortalEvent.MessageType.DENY);
             if (hasPermission) {
                 Stargate.log(Level.CONFIG, " Access event was denied externally");
             }

src/main/java/org/sgrewritten/stargate/network/portal/Teleporter.java

@@ -15,6 +15,7 @@
 import org.sgrewritten.stargate.action.DelayedAction;
 import org.sgrewritten.stargate.action.SimpleAction;
 import org.sgrewritten.stargate.action.SupplierAction;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.api.network.portal.PortalFlag;
 import org.sgrewritten.stargate.api.network.portal.RealPortal;
 import org.sgrewritten.stargate.config.ConfigurationHelper;
@@ -25,6 +26,7 @@
 import org.sgrewritten.stargate.formatting.TranslatableMessage;
 import org.sgrewritten.stargate.manager.StargatePermissionManager;
 import org.sgrewritten.stargate.property.NonLegacyMethod;
+import org.sgrewritten.stargate.util.MessageUtils;
 import org.sgrewritten.stargate.util.portal.TeleportationHelper;
 import org.sgrewritten.stargate.vectorlogic.VectorUtils;
 
@@ -389,8 +391,7 @@ private void teleport(Entity target, Location exitPoint) {
         target.teleport(exitPoint);
         boatsTeleporting.remove(target);
         if (origin != null && !origin.hasFlag(PortalFlag.SILENT)) {
-            Stargate.log(Level.FINE, "Sending player teleport message" + teleportMessage);
-            target.sendMessage(teleportMessage);
+            MessageUtils.sendMessageFromPortal(origin,target,teleportMessage,StargateSendMessagePortalEvent.MessageType.DENY);
         }
     }
 

src/main/java/org/sgrewritten/stargate/util/MessageUtils.java

@@ -0,0 +1,20 @@
+package org.sgrewritten.stargate.util;
+
+import org.bukkit.Bukkit;
+import org.bukkit.entity.Entity;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
+import org.sgrewritten.stargate.api.network.portal.Portal;
+
+public class MessageUtils {
+
+    public static void sendMessageFromPortal(Portal portal, Entity receiver, String message, StargateSendMessagePortalEvent.MessageType type){
+        if(message == null || message.isBlank()){
+            return;
+        }
+        StargateSendMessagePortalEvent sendMessageEvent = new StargateSendMessagePortalEvent(portal,receiver,type);
+        Bukkit.getPluginManager().callEvent(sendMessageEvent);
+        if(!sendMessageEvent.isCancelled()){
+            receiver.sendMessage(message);
+        }
+    }
+}

src/main/java/org/sgrewritten/stargate/util/portal/PortalCreationHelper.java

@@ -10,6 +10,7 @@
 import org.bukkit.entity.Player;
 import org.bukkit.util.BlockVector;
 import org.sgrewritten.stargate.Stargate;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.api.gate.GateAPI;
 import org.sgrewritten.stargate.api.StargateAPI;
 import org.sgrewritten.stargate.api.gate.GateStructureType;
@@ -35,11 +36,7 @@
 import org.sgrewritten.stargate.network.portal.portaldata.PortalData;
 import org.sgrewritten.stargate.api.network.portal.RealPortal;
 import org.sgrewritten.stargate.api.permission.BypassPermission;
-import org.sgrewritten.stargate.util.EconomyHelper;
-import org.sgrewritten.stargate.util.NameHelper;
-import org.sgrewritten.stargate.util.NetworkCreationHelper;
-import org.sgrewritten.stargate.util.SpawnDetectionHelper;
-import org.sgrewritten.stargate.util.TranslatableMessageFormatter;
+import org.sgrewritten.stargate.util.*;
 import org.sgrewritten.stargate.vectorlogic.VectorUtils;
 
 import java.util.*;
@@ -141,11 +138,13 @@ public static void tryPortalCreation(Network selectedNetwork, String[] lines, Bl
         //If the create event has been denied, tell the user and abort
         if (portalCreateEvent.getDeny()) {
             Stargate.log(Level.CONFIG, " Event was denied due to lack of permission or an add-on");
+            String message = null;
             if (portalCreateEvent.getDenyReason() == null) {
-                player.sendMessage(stargateAPI.getLanguageManager().getErrorMessage(TranslatableMessage.ADDON_INTERFERE));
+                message = stargateAPI.getLanguageManager().getErrorMessage(TranslatableMessage.ADDON_INTERFERE);
             } else if (!portalCreateEvent.getDenyReason().isEmpty()) {
-                player.sendMessage(portalCreateEvent.getDenyReason());
+                message = portalCreateEvent.getDenyReason();
             }
+            MessageUtils.sendMessageFromPortal(portal,player,message, StargateSendMessagePortalEvent.MessageType.DENY);
             return;
         }
 

src/main/java/org/sgrewritten/stargate/util/portal/PortalDestructionHelper.java

@@ -2,6 +2,7 @@
 
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
+import org.sgrewritten.stargate.api.event.portal.StargateSendMessagePortalEvent;
 import org.sgrewritten.stargate.config.ConfigurationHelper;
 import org.sgrewritten.stargate.api.config.ConfigurationOption;
 import org.sgrewritten.stargate.economy.StargateEconomyAPI;
@@ -13,6 +14,7 @@
 import org.sgrewritten.stargate.api.network.portal.RealPortal;
 import org.sgrewritten.stargate.api.permission.BypassPermission;
 import org.sgrewritten.stargate.util.EconomyHelper;
+import org.sgrewritten.stargate.util.MessageUtils;
 
 /**
  * A helper class for removing an existing portal
@@ -42,12 +44,13 @@ public static boolean destroyPortalIfHasPermissionAndCanPay(Player player, Porta
 
         // Inform the player why the destruction was denied
         if (portalDestroyEvent.getDeny()) {
+            String message = null;
             if (portalDestroyEvent.getDenyReason() == null) {
-                player.sendMessage(
-                        languageManager.getErrorMessage(TranslatableMessage.ADDON_INTERFERE));
+                message = languageManager.getErrorMessage(TranslatableMessage.ADDON_INTERFERE);
             } else if (!portalDestroyEvent.getDenyReason().isEmpty()) {
-                player.sendMessage(portalDestroyEvent.getDenyReason());
+                message = portalDestroyEvent.getDenyReason();
             }
+            MessageUtils.sendMessageFromPortal(portal,player,message, StargateSendMessagePortalEvent.MessageType.DENY);
             return true;
         }