Updates changelog and version to 0.9.0.4

Un-leashes and re-leashes teleported leashed entities
Delays leashed creature teleportation and the re-leashing to prevent odd behavior such as infinite leash or no-ai creature

README.md

@@ -301,6 +301,7 @@ gates:
   functionality:
     enableBungee - Enable this for BungeeCord support. This allows portals across Bungee servers.
     handleVehicles - Whether or not to handle vehicles going through gates. Set to false to disallow vehicles (Manned or not) going through gates.
+    handleLeashedCreatures - Whether or not to handle creatures leashed by a player going through gates. Set to false to disallow leashed creatures going through gates.
 economy:
   useEconomy - Whether or not to enable Economy using Vault (must have the Vault plugin)
   createCost - The cost to create a stargate
@@ -367,6 +368,12 @@ bungeeSign=Teleport to
 
 # Changes
 
+#### \[Version 0.9.0.4] EpicKnarvik97 fork
+
+- Adds teleportation of leashed creatures. By default, any creature connected to a player by a lead will be teleported
+  with the player through stargates, even if the player is in a vehicle. This behavior can be disabled in the config
+  file.
+
 #### \[Version 0.9.0.3] EpicKnarvik97 fork
 
 - Adds a missing error message when a player in a vehicle cannot pay the teleportation fee

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>net.knarcraft</groupId>
     <artifactId>Stargate</artifactId>
-    <version>0.9.0.3</version>
+    <version>0.9.0.4</version>
 
     <licenses>
         <license>

src/main/java/net/knarcraft/stargate/config/StargateGateConfig.java

@@ -13,6 +13,7 @@ public final class StargateGateConfig {
     private int maxGatesEachNetwork = 0;
     private boolean rememberDestination = false;
     private boolean handleVehicles = true;
+    private boolean handleLeashedCreatures = true;
     private boolean sortNetworkDestinations = false;
     private boolean protectEntrance = false;
     private boolean enableBungee = true;
@@ -76,6 +77,15 @@ public final class StargateGateConfig {
         return handleVehicles;
     }
 
+    /**
+     * Gets whether leashed creatures should be teleported with a teleporting player
+     *
+     * @return <p>Whether leashed creatures should be handled</p>
+     */
+    public boolean handleLeashedCreatures() {
+        return handleLeashedCreatures;
+    }
+
     /**
      * Gets whether the list of destinations within a network should be sorted
      *
@@ -142,6 +152,7 @@ public final class StargateGateConfig {
 
         //Functionality
         handleVehicles = newConfig.getBoolean("gates.functionality.handleVehicles");
+        handleLeashedCreatures = newConfig.getBoolean("gates.functionality.handleLeashedCreatures");
         enableBungee = newConfig.getBoolean("gates.functionality.enableBungee");
 
         //Integrity
@@ -173,5 +184,4 @@ public final class StargateGateConfig {
         Stargate.logWarning("You have specified an invalid color in your config.yml. Defaulting to BLACK and WHITE");
         PortalSignDrawer.setColors(ChatColor.BLACK, ChatColor.WHITE);
     }
-
 }

src/main/java/net/knarcraft/stargate/portal/EntityTeleporter.java

@@ -0,0 +1,69 @@
+package net.knarcraft.stargate.portal;
+
+import net.knarcraft.stargate.Stargate;
+import net.knarcraft.stargate.event.StargateEntityPortalEvent;
+import org.bukkit.Location;
+import org.bukkit.entity.Entity;
+
+/**
+ * The portal teleporter takes care of the actual portal teleportation for any entities
+ */
+public class EntityTeleporter extends Teleporter {
+
+    private final Entity teleportingEntity;
+
+    /**
+     * Instantiates a new portal teleporter
+     *
+     * @param portal <p>The portal which is the target of the teleportation</p>
+     */
+    public EntityTeleporter(Portal portal, Entity teleportingEntity) {
+        super(portal);
+        this.teleportingEntity = teleportingEntity;
+    }
+
+    /**
+     * Teleports an entity to this teleporter's portal
+     *
+     * @param origin <p>The portal the entity is teleporting from</p>
+     */
+    public void teleport(Portal origin) {
+        Location traveller = teleportingEntity.getLocation();
+        Location exit = getExit(teleportingEntity, traveller);
+
+        //Rotate the entity to face out from the portal
+        adjustRotation(exit);
+
+        //Call the StargateEntityPortalEvent to allow plugins to change destination
+        if (!origin.equals(portal)) {
+            exit = triggerEntityPortalEvent(origin, exit);
+            if (exit == null) {
+                return;
+            }
+        }
+
+        //Load chunks to make sure not to teleport to the void
+        loadChunks();
+
+        teleportingEntity.teleport(exit);
+    }
+
+    /**
+     * Triggers the entity portal event to allow plugins to change the exit location
+     *
+     * @param origin <p>The origin portal teleported from</p>
+     * @param exit   <p>The exit location to teleport the entity to</p>
+     * @return <p>The location the entity should be teleported to, or null if the event was cancelled</p>
+     */
+    protected Location triggerEntityPortalEvent(Portal origin, Location exit) {
+        StargateEntityPortalEvent stargateEntityPortalEvent = new StargateEntityPortalEvent(teleportingEntity, origin,
+                portal, exit);
+        Stargate.getInstance().getServer().getPluginManager().callEvent(stargateEntityPortalEvent);
+        //Teleport is cancelled. Teleport the entity back to where it came from just for sanity's sake
+        if (stargateEntityPortalEvent.isCancelled()) {
+            new EntityTeleporter(origin, teleportingEntity).teleport(origin);
+            return null;
+        }
+        return stargateEntityPortalEvent.getExit();
+    }
+}

src/main/java/net/knarcraft/stargate/portal/PlayerTeleporter.java

@@ -48,6 +48,9 @@ public class PlayerTeleporter extends Teleporter {
         //Load chunks to make sure not to teleport to the void
         loadChunks();
 
+        //Teleport any creatures leashed by the player in a 15-block range
+        teleportLeashedCreatures(player, origin);
+
         //If no event is passed in, assume it's a teleport, and act as such
         if (event == null) {
             player.teleport(exit);

src/main/java/net/knarcraft/stargate/portal/Teleporter.java

@@ -13,7 +13,9 @@ import org.bukkit.block.data.Bisected;
 import org.bukkit.block.data.BlockData;
 import org.bukkit.block.data.type.Slab;
 import org.bukkit.entity.AbstractHorse;
+import org.bukkit.entity.Creature;
 import org.bukkit.entity.Entity;
+import org.bukkit.entity.Player;
 import org.bukkit.scheduler.BukkitScheduler;
 
 import java.util.ArrayList;
@@ -247,4 +249,47 @@ public abstract class Teleporter {
         return chunksToLoad;
     }
 
+    /**
+     * Teleports any creatures leashed by the player
+     *
+     * @param player <p>The player which is teleported</p>
+     * @param origin <p>The portal the player is teleporting from</p>
+     */
+    protected void teleportLeashedCreatures(Player player, Portal origin) {
+        //If this feature is disabled, just return
+        if (!Stargate.getGateConfig().handleLeashedCreatures()) {
+            return;
+        }
+
+        //Find any nearby leashed entities to teleport with the player
+        List<Creature> nearbyEntities = getLeashedCreatures(player);
+        //Teleport all creatures leashed by the player to the portal the player is to exit from
+        for (Creature creature : nearbyEntities) {
+            creature.setLeashHolder(null);
+            scheduler.scheduleSyncDelayedTask(Stargate.getInstance(), () -> {
+                new EntityTeleporter(portal, creature).teleport(origin);
+                scheduler.scheduleSyncDelayedTask(Stargate.getInstance(), () -> creature.setLeashHolder(player), 3);
+            }, 2);
+        }
+    }
+
+    /**
+     * Gets all creatures leashed by a player within the given range
+     *
+     * @param player <p>The player to check</p>
+     * @return <p>A list of all creatures the player is holding in a leash (lead)</p>
+     */
+    protected List<Creature> getLeashedCreatures(Player player) {
+        List<Creature> leashedCreatures = new ArrayList<>();
+        //Find any nearby leashed entities to teleport with the player
+        List<Entity> nearbyEntities = player.getNearbyEntities(15, 15, 15);
+        //Teleport all creatures leashed by the player to the portal the player is to exit from
+        for (Entity entity : nearbyEntities) {
+            if (entity instanceof Creature creature && creature.isLeashed() && creature.getLeashHolder() == player) {
+                leashedCreatures.add(creature);
+            }
+        }
+        return leashedCreatures;
+    }
+
 }

src/main/java/net/knarcraft/stargate/portal/VehicleTeleporter.java

@@ -1,12 +1,12 @@
 package net.knarcraft.stargate.portal;
 
 import net.knarcraft.stargate.Stargate;
-import net.knarcraft.stargate.event.StargateEntityPortalEvent;
 import net.knarcraft.stargate.utility.DirectionHelper;
 import org.bukkit.Location;
 import org.bukkit.World;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.Player;
 import org.bukkit.entity.Vehicle;
 import org.bukkit.util.Vector;
 
@@ -15,7 +15,7 @@ import java.util.List;
 /**
  * The portal teleporter takes care of the actual portal teleportation for any vehicles
  */
-public class VehicleTeleporter extends Teleporter {
+public class VehicleTeleporter extends EntityTeleporter {
 
     private final Vehicle teleportingVehicle;
 
@@ -26,7 +26,7 @@ public class VehicleTeleporter extends Teleporter {
      * @param teleportingVehicle <p>The teleporting vehicle</p>
      */
     public VehicleTeleporter(Portal portal, Vehicle teleportingVehicle) {
-        super(portal);
+        super(portal, teleportingVehicle);
         this.teleportingVehicle = teleportingVehicle;
     }
 
@@ -36,8 +36,9 @@ public class VehicleTeleporter extends Teleporter {
      * <p>It is assumed that if a vehicle contains any players, their permissions have already been validated before
      * calling this method.</p>
      *
-     * @param origin <p>The portal the vehicle teleports from</p>
+     * @param origin <p>The portal the vehicle is teleporting from</p>
      */
+    @Override
     public void teleport(Portal origin) {
         Location traveller = teleportingVehicle.getLocation();
         Location exit = getExit(teleportingVehicle, traveller);
@@ -63,7 +64,7 @@ public class VehicleTeleporter extends Teleporter {
         }
 
         //Teleport the vehicle
-        teleportVehicle(exit, newVelocity);
+        teleportVehicle(exit, newVelocity, origin);
     }
 
     /**
@@ -71,8 +72,9 @@ public class VehicleTeleporter extends Teleporter {
      *
      * @param exit        <p>The location the vehicle should be teleported to</p>
      * @param newVelocity <p>The velocity to give the vehicle right after teleportation</p>
+     * @param origin      <p>The portal the vehicle teleported from</p>
      */
-    private void teleportVehicle(Location exit, Vector newVelocity) {
+    private void teleportVehicle(Location exit, Vector newVelocity, Portal origin) {
         //Load chunks to make sure not to teleport to the void
         loadChunks();
 
@@ -80,10 +82,10 @@ public class VehicleTeleporter extends Teleporter {
         if (!passengers.isEmpty()) {
             if (!(teleportingVehicle instanceof LivingEntity)) {
                 //Teleport a normal vehicle with passengers (minecart or boat)
-                putPassengersInNewVehicle(passengers, exit, newVelocity);
+                putPassengersInNewVehicle(passengers, exit, newVelocity, origin);
             } else {
                 //Teleport a living vehicle with passengers (pig, horse, donkey, strider)
-                teleportLivingVehicle(exit, passengers);
+                teleportLivingVehicle(exit, passengers, origin);
             }
         } else {
             //Teleport an empty vehicle
@@ -93,35 +95,17 @@ public class VehicleTeleporter extends Teleporter {
         }
     }
 
-    /**
-     * Triggers the entity portal event to allow plugins to change the exit location
-     *
-     * @param origin <p>The origin portal teleported from</p>
-     * @param exit   <p>The exit location to teleport the vehicle to</p>
-     * @return <p>The location the vehicle should be teleported to, or null if the event was cancelled</p>
-     */
-    private Location triggerEntityPortalEvent(Portal origin, Location exit) {
-        StargateEntityPortalEvent stargateEntityPortalEvent = new StargateEntityPortalEvent(teleportingVehicle, origin,
-                portal, exit);
-        Stargate.getInstance().getServer().getPluginManager().callEvent(stargateEntityPortalEvent);
-        //Teleport is cancelled. Teleport the entity back to where it came from just for sanity's sake
-        if (stargateEntityPortalEvent.isCancelled()) {
-            new VehicleTeleporter(origin, teleportingVehicle).teleport(origin);
-            return null;
-        }
-        return stargateEntityPortalEvent.getExit();
-    }
-
     /**
      * Teleport a vehicle which is not a minecart or a boat
      *
      * @param exit       <p>The location the vehicle will exit</p>
      * @param passengers <p>The passengers of the vehicle</p>
+     * @param origin     <p>The portal the vehicle teleported from</p>
      */
-    private void teleportLivingVehicle(Location exit, List<Entity> passengers) {
+    private void teleportLivingVehicle(Location exit, List<Entity> passengers, Portal origin) {
         teleportingVehicle.eject();
         teleportingVehicle.teleport(exit);
-        handleVehiclePassengers(passengers, teleportingVehicle, 2);
+        handleVehiclePassengers(passengers, teleportingVehicle, 2, origin);
     }
 
     /**
@@ -134,9 +118,10 @@ public class VehicleTeleporter extends Teleporter {
      * @param passengers  <p>A list of all passengers in the vehicle</p>
      * @param exit        <p>The exit location to spawn the new vehicle on</p>
      * @param newVelocity <p>The new velocity of the new vehicle</p>
+     * @param origin      <p>The portal the vehicle teleported from</p>
      */
     private void putPassengersInNewVehicle(List<Entity> passengers, Location exit,
-                                           Vector newVelocity) {
+                                           Vector newVelocity, Portal origin) {
         World vehicleWorld = exit.getWorld();
         if (vehicleWorld == null) {
             Stargate.logWarning("Unable to get the world to teleport the vehicle to");
@@ -149,7 +134,7 @@ public class VehicleTeleporter extends Teleporter {
         teleportingVehicle.remove();
         //Set rotation, add passengers and restore velocity
         newVehicle.setRotation(exit.getYaw(), exit.getPitch());
-        handleVehiclePassengers(passengers, newVehicle, 1);
+        handleVehiclePassengers(passengers, newVehicle, 1, origin);
         scheduler.scheduleSyncDelayedTask(Stargate.getInstance(), () -> newVehicle.setVelocity(newVelocity), 1);
     }
 
@@ -159,12 +144,18 @@ public class VehicleTeleporter extends Teleporter {
      * @param passengers <p>The passengers to handle</p>
      * @param vehicle    <p>The vehicle the passengers should be put into</p>
      * @param delay      <p>The amount of milliseconds to wait before adding the vehicle passengers</p>
+     * @param origin     <p>The portal the vehicle teleported from</p>
      */
-    private void handleVehiclePassengers(List<Entity> passengers, Vehicle vehicle, long delay) {
+    private void handleVehiclePassengers(List<Entity> passengers, Vehicle vehicle, long delay, Portal origin) {
         for (Entity passenger : passengers) {
             passenger.eject();
-            scheduler.scheduleSyncDelayedTask(Stargate.getInstance(), () -> teleportAndAddPassenger(vehicle, passenger),
-                    delay);
+            scheduler.scheduleSyncDelayedTask(Stargate.getInstance(), () -> {
+                if (passenger instanceof Player player) {
+                    //Teleport any creatures leashed by the player in a 15-block range
+                    teleportLeashedCreatures(player, origin);
+                }
+                teleportAndAddPassenger(vehicle, passenger);
+            }, delay);
         }
     }
 

src/main/resources/config.yml

@@ -9,6 +9,7 @@
 # language - The language file to load for messages
 # rememberDestination - Whether to remember the cursor location between uses
 # handleVehicles - Whether to allow vehicles through gates
+# handleLeashedCreatures - Whether to allow creatures lead by a player to teleport with the player
 # sortNetworkDestinations - Whether to sort network lists alphabetically
 # protectEntrance - Whether to protect gate entrance material (More resource intensive. Only enable if using destroyable open/closed material)
 # mainSignColor - The color used for drawing signs (Default: BLACK).
@@ -49,6 +50,7 @@ gates:
   functionality:
     enableBungee: false
     handleVehicles: true
+    handleLeashedCreatures: true
 economy:
   useEconomy: false
   createCost: 0

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 name: Stargate
 main: net.knarcraft.stargate.Stargate
-version: 0.9.0.3
+version: 0.9.0.4
 description: Stargate mod for Bukkit Revived
 author: EpicKnarvik97
 authors: [ Drakia, PseudoKnight, EpicKnarvik97 ]