Portal Mechanics (Closes #130)

src/main/java/net/glowstone/GlowWorld.java

@@ -60,6 +60,7 @@
 import net.glowstone.net.message.play.player.ServerDifficultyMessage;
 import net.glowstone.util.BlockStateDelegate;
 import net.glowstone.util.GameRuleManager;
+import net.glowstone.util.GlowTravelAgent;
 import net.glowstone.util.RayUtil;
 import net.glowstone.util.TickUtil;
 import net.glowstone.util.collection.ConcurrentSet;
@@ -376,6 +377,11 @@ public LightningStrike strikeLightningEffect(Location loc, boolean isSilent) {
      */
     @Getter
     private boolean initialized;
+    /**
+     * The TravelAgent of this world. Currently is null when this world is a THE_END world.
+     */
+    @Getter
+    private GlowTravelAgent travelAgent;
 
     /**
      * Creates a new world from the options in the given WorldCreator.
@@ -391,6 +397,10 @@ public GlowWorld(GlowServer server, WorldCreator creator,
         // set up values from WorldCreator
         name = creator.name();
         environment = creator.environment();
+        // end portals are not implemented yet
+        if (environment != Environment.THE_END) {
+            travelAgent = new GlowTravelAgent(this);
+        }
         worldType = creator.type();
         generateStructures = creator.generateStructures();
 

src/main/java/net/glowstone/block/ItemTable.java

@@ -68,6 +68,7 @@
 import net.glowstone.block.blocktype.BlockObserver;
 import net.glowstone.block.blocktype.BlockOre;
 import net.glowstone.block.blocktype.BlockPiston;
+import net.glowstone.block.blocktype.BlockPortal;
 import net.glowstone.block.blocktype.BlockPotato;
 import net.glowstone.block.blocktype.BlockPumpkin;
 import net.glowstone.block.blocktype.BlockPumpkinBase;
@@ -273,6 +274,7 @@ private void registerBuiltins() {
         reg(Material.WEB, new BlockWeb());
         reg(Material.FIRE, new BlockFire());
         reg(Material.ENDER_PORTAL_FRAME, new BlockEnderPortalFrame());
+        reg(Material.PORTAL, new BlockPortal());
         reg(Material.FENCE_GATE, new BlockFenceGate());
         reg(Material.ACACIA_FENCE_GATE, new BlockFenceGate());
         reg(Material.BIRCH_FENCE_GATE, new BlockFenceGate());

src/main/java/net/glowstone/block/blocktype/BlockEnderPortalFrame.java

@@ -55,7 +55,7 @@ public boolean blockInteract(GlowPlayer player, GlowBlock block, BlockFace face,
 
             block.setData((byte) (block.getData() | 0x4));
             if (block.getWorld().getEnvironment() != Environment.THE_END) {
-                searchForCompletedPortal(player, block);
+                searchForCompletedEnderPortal(player, block);
             }
             return true;
         }
@@ -65,13 +65,13 @@ public boolean blockInteract(GlowPlayer player, GlowBlock block, BlockFace face,
     /**
      * Checks for a completed portal at all relevant positions.
      */
-    private void searchForCompletedPortal(GlowPlayer player, GlowBlock changed) {
+    private void searchForCompletedEnderPortal(GlowPlayer player, GlowBlock changed) {
         for (int i = 0; i < 4; i++) {
             for (int j = -1; j <= 1; j++) {
                 GlowBlock center = changed.getRelative(SIDES[i], 2)
                     .getRelative(SIDES[(i + 1) % 4], j);
-                if (isCompletedPortal(center)) {
-                    createPortal(player, center);
+                if (isCompletedEnderPortal(center)) {
+                    createEnderPortal(player, center);
                     return;
                 }
             }
@@ -81,7 +81,7 @@ private void searchForCompletedPortal(GlowPlayer player, GlowBlock changed) {
     /**
      * Check whether there is a completed portal with the specified center.
      */
-    private boolean isCompletedPortal(GlowBlock center) {
+    private boolean isCompletedEnderPortal(GlowBlock center) {
         for (int i = 0; i < 4; i++) {
             for (int j = -1; j <= 1; j++) {
                 GlowBlock block = center.getRelative(SIDES[i], 2)
@@ -98,7 +98,7 @@ private boolean isCompletedPortal(GlowBlock center) {
     /**
      * Spawn the portal and call the {@link EntityCreatePortalEvent}.
      */
-    private void createPortal(GlowPlayer player, GlowBlock center) {
+    private void createEnderPortal(GlowPlayer player, GlowBlock center) {
         List<BlockState> blocks = new ArrayList<>(9);
         for (int i = -1; i <= 1; i++) {
             for (int j = -1; j <= 1; j++) {

src/main/java/net/glowstone/block/blocktype/BlockPortal.java

@@ -0,0 +1,87 @@
+package net.glowstone.block.blocktype;
+
+import java.util.concurrent.ThreadLocalRandom;
+import net.glowstone.GlowServer;
+import net.glowstone.GlowWorld;
+import net.glowstone.block.GlowBlock;
+import net.glowstone.entity.monster.GlowPigZombie;
+import net.glowstone.entity.physics.BoundingBox;
+import net.glowstone.util.pattern.PortalShape;
+import org.bukkit.Location;
+import org.bukkit.Material;
+import org.bukkit.World;
+import org.bukkit.block.BlockFace;
+import org.bukkit.event.entity.CreatureSpawnEvent;
+import org.bukkit.util.Vector;
+
+public class BlockPortal extends BlockType {
+
+    @Override
+    public void onNearBlockChanged(final GlowBlock block, BlockFace face, GlowBlock changedBlock,
+                                   Material oldType, byte oldData, Material newType, byte newData) {
+        if (newType == oldType || (oldType != Material.PORTAL && oldType != Material.OBSIDIAN)) {
+            return;
+        }
+        BlockFace left = getFace(block.getData());
+        if (left == null) {
+            return;
+        }
+        PortalShape shape = new PortalShape(block.getLocation(), left);
+        if (shape.validate()
+                && shape.getPortalBlockCount() == shape.getHeight() * shape.getWidth()) {
+            return;
+        }
+        block.setType(Material.AIR);
+    }
+
+    public static BoundingBox getBoundingBox(GlowBlock block) {
+        boolean north = getFace(block.getData()) == BlockFace.NORTH;
+        Vector base = new Vector(north ? .375 : 0, 0, north ? 0 : .375);
+        Vector size = new Vector(north ? .25 : 1, 1, north ? 1 : .25);
+        return BoundingBox.fromPositionAndSize(block.getLocation().toVector().add(base), size);
+    }
+
+    private static BlockFace getFace(int blockData) {
+        int faceData = blockData & 3;
+        return faceData == 1 ? BlockFace.WEST : faceData == 2 ? BlockFace.NORTH : null;
+    }
+
+    @Override
+    public void updateBlock(GlowBlock block) {
+        // remove invalid portal blocks
+        if ((block.getData() & 3) == 0) {
+            block.setType(Material.AIR);
+            System.out.println(block.getLocation());
+            return;
+        }
+        GlowWorld world = block.getWorld();
+        GlowServer server = world.getServer();
+        // No pigman spawns without nether
+        if (!server.getAllowNether()
+            // Pigmen only spawn in overworld
+            || world.getEnvironment() != World.Environment.NORMAL
+            // Pigmen spawning explicitly disabled
+            // TODO: Uncomment after implementing Spigot config
+            //|| !server.spigot().getSpigotConfig().
+            //getBoolean("enable-zombie-pigmen-portal-spawns")
+            // Increasing spawn chance with increasing difficulty.
+            // If random * 2000 is 0, it is still not bigger than the ordinal of peaceful (0)
+            || ThreadLocalRandom.current().nextInt(2000) > world.getDifficulty().ordinal()
+        ) {
+            return;
+        }
+
+        Location location = block.getLocation();
+        //move down to the bottom of the portal
+        while (location.getBlock().getType() == Material.PORTAL && location.getY() > 0) {
+            location.subtract(0, 1, 0);
+        }
+        world.spawn(location.add(.5, 2.1, .5), GlowPigZombie.class,
+            CreatureSpawnEvent.SpawnReason.NETHER_PORTAL);
+    }
+
+    @Override
+    public boolean canTickRandomly() {
+        return true;
+    }
+}

src/main/java/net/glowstone/block/itemtype/ItemFlintAndSteel.java

@@ -5,6 +5,8 @@
 import net.glowstone.block.ItemTable;
 import net.glowstone.block.blocktype.BlockTnt;
 import net.glowstone.entity.GlowPlayer;
+import net.glowstone.util.pattern.PortalShape;
+import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.block.BlockFace;
 import org.bukkit.event.block.BlockIgniteEvent;
@@ -13,6 +15,7 @@
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.util.Vector;
 
+
 public class ItemFlintAndSteel extends ItemTool {
 
     public ItemFlintAndSteel() {
@@ -21,60 +24,74 @@ public ItemFlintAndSteel() {
 
     @Override
     public boolean onToolRightClick(GlowPlayer player, GlowBlock target, BlockFace face,
-        ItemStack holding, Vector clickedLoc, EquipmentSlot hand) {
-        if (target.getType() == Material.OBSIDIAN) {
-            fireNetherPortal(target, face);
-            return true;
-        }
+                                    ItemStack holding, Vector clickedLoc, EquipmentSlot hand) {
         if (target.getType() == Material.TNT) {
             fireTnt(target, player);
             return true;
         }
+
+        if (tryFireNetherPortal(target, face)) {
+            return true;
+        }
+
         if (target.isFlammable() || target.getType().isOccluding()) {
             setBlockOnFire(player, target, face, holding, clickedLoc, hand);
             return true;
         }
         return false;
     }
 
-    private void fireNetherPortal(GlowBlock target, BlockFace face) {
-        if (face == BlockFace.UP || face == BlockFace.DOWN) {
-            target = target.getRelative(face);
-            int limit = 0;
-            while (target.getType() == Material.AIR && limit < 23) {
-                target.setType(Material.PORTAL);
-                target = target.getRelative(face);
-                limit++;
+    /**
+     * Try to fire a nether portal at the given position.
+     *
+     * @param target the target block
+     * @param face   the face from which the block was fired
+     * @return whether a portal could be fired
+     */
+    private boolean tryFireNetherPortal(GlowBlock target, BlockFace face) {
+        // Where fire would be placed if this is not a portal
+        Location fireLocation =
+                target.getLocation().add(face.getModX(), face.getModY(), face.getModZ());
+
+        PortalShape shape = new PortalShape(fireLocation, BlockFace.WEST);
+        if (!shape.validate() || shape.getPortalBlockCount() != 0) {
+            shape = new PortalShape(fireLocation, BlockFace.NORTH);
+            if (!shape.validate() || shape.getPortalBlockCount() != 0) {
+                return false;
             }
+            shape.placePortalBlocks();
+            return true;
         }
+        shape.placePortalBlocks();
+        return true;
     }
 
-    private void fireTnt(GlowBlock tnt,GlowPlayer player) {
+    private void fireTnt(GlowBlock tnt, GlowPlayer player) {
         BlockTnt.igniteBlock(tnt, false, player);
     }
 
     private boolean setBlockOnFire(GlowPlayer player, GlowBlock clicked, BlockFace face,
-        ItemStack holding, Vector clickedLoc, EquipmentSlot hand) {
+                                   ItemStack holding, Vector clickedLoc, EquipmentSlot hand) {
         GlowBlock fireBlock = clicked.getRelative(face);
         if (fireBlock.getType() != Material.AIR) {
             return true;
         }
 
         if (!clicked.isFlammable()
-            && clicked.getRelative(BlockFace.DOWN).getType() == Material.AIR) {
+                && clicked.getRelative(BlockFace.DOWN).getType() == Material.AIR) {
             return true;
         }
 
-        BlockIgniteEvent event = EventFactory.getInstance()
-            .callEvent(new BlockIgniteEvent(fireBlock, IgniteCause.FLINT_AND_STEEL, player, null));
+        BlockIgniteEvent event = EventFactory.getInstance().callEvent(
+                new BlockIgniteEvent(fireBlock, IgniteCause.FLINT_AND_STEEL, player, null));
         if (event.isCancelled()) {
             player.setItemInHand(holding);
             return false;
         }
 
         // clone holding to avoid decreasing of the item's amount
         ItemTable.instance().getBlock(Material.FIRE)
-            .rightClickBlock(player, clicked, face, holding.clone(), clickedLoc, hand);
+                .rightClickBlock(player, clicked, face, holding.clone(), clickedLoc, hand);
 
         return true;
     }

src/main/java/net/glowstone/entity/GlowEntity.java

@@ -23,6 +23,8 @@
 import net.glowstone.EventFactory;
 import net.glowstone.GlowServer;
 import net.glowstone.GlowWorld;
+import net.glowstone.block.GlowBlock;
+import net.glowstone.block.blocktype.BlockPortal;
 import net.glowstone.chunk.GlowChunk;
 import net.glowstone.entity.meta.MetadataIndex;
 import net.glowstone.entity.meta.MetadataIndex.StatusFlags;
@@ -50,6 +52,7 @@
 import org.bukkit.EntityEffect;
 import org.bukkit.Location;
 import org.bukkit.Material;
+import org.bukkit.TravelAgent;
 import org.bukkit.World;
 import org.bukkit.World.Environment;
 import org.bukkit.block.Block;
@@ -291,6 +294,10 @@ public abstract class GlowEntity implements Entity {
     @Getter
     @Setter
     private int portalCooldown;
+
+    @Getter
+    private boolean isInPortal;
+
     /**
      * Whether this entity has operator permissions.
      */
@@ -560,6 +567,9 @@ public void pulse() {
         if (fireTicks > 0) {
             --fireTicks;
         }
+        if (portalCooldown > 0) {
+            --portalCooldown;
+        }
         metadata.setBit(MetadataIndex.STATUS, StatusFlags.ON_FIRE, fireTicks > 0);
 
         // resend position if it's been a while, causes ItemFrames to disappear and GlowPaintings
@@ -605,6 +615,40 @@ public void pulse() {
                 }
             }
         }
+        GlowBlock block = world.getBlockAt(location);
+        if (block.getType().equals(Material.PORTAL)
+            && BlockPortal.getBoundingBox(block).intersects(boundingBox)) {
+            if (!isInPortal) {
+                EventFactory.getInstance().callEvent(
+                    new EntityPortalEnterEvent(this, block.getLocation()));
+                isInPortal = true;
+            }
+            if (server.getAllowNether() && portalCooldown <= 0) {
+                GlowWorld w = getWorld().getEnvironment().equals(Environment.NETHER)
+                    ? server.getWorld("world") : server.getWorld("world_nether");
+                TravelAgent agent = w.getTravelAgent();
+                boolean destIsNether = w.getEnvironment().equals(Environment.NETHER);
+                int destX = destIsNether ? location.getBlockX() / 8 : location.getBlockX() * 8;
+                int destY = destIsNether ? location.getBlockY() / 8 : location.getBlockY() * 8;
+                int destZ = destIsNether ? location.getBlockZ() / 8 : location.getBlockZ() * 8;
+                Location requested = new Location(w, destX, destY, destZ);
+                if (agent.getCanCreatePortal() || agent.findPortal(requested) != null) {
+                    Location teleportLocation = agent.findOrCreate(requested);
+                    EntityPortalEvent p = EventFactory.getInstance().callEvent(
+                        new EntityPortalEvent(this,
+                            location.clone(), teleportLocation.clone(), agent));
+                    if (!p.isCancelled()) {
+                        teleport(p.getTo());
+                        setPortalCooldown(300);
+                        setVelocity(EventFactory.getInstance().callEvent(
+                            new EntityPortalExitEvent(this, previousLocation,
+                                location.clone(), velocity.clone(), new Vector())).getAfter());
+                    }
+                }
+            }
+        } else {
+            isInPortal = false;
+        }
 
         if (leashHolderUniqueId != null && ticksLived < 2) {
             Optional<GlowEntity> any = world.getEntityManager().getAll().stream()