/* GriefPrevention Server Plugin for Minecraft Copyright (C) 2012 Ryan Hamshire This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ package me.ryanhamshire.GriefPrevention; import org.bukkit.Location; import org.bukkit.Material; import org.bukkit.Tag; import org.bukkit.World; import org.bukkit.block.Block; import org.bukkit.block.BlockFace; import org.bukkit.block.data.BlockData; import org.bukkit.block.data.Lightable; import org.bukkit.entity.Player; import org.bukkit.util.BoundingBox; import org.bukkit.util.Vector; import java.util.ArrayList; //represents a visualization sent to a player //FEATURE: to show players visually where claim boundaries are, we send them fake block change packets //the result is that those players see new blocks, but the world hasn't been changed. other players can't see the new blocks, either. public class Visualization { public ArrayList elements = new ArrayList<>(); //sends a visualization to a player public static void Apply(Player player, Visualization visualization) { PlayerData playerData = GriefPrevention.instance.dataStore.getPlayerData(player.getUniqueId()); //if he has any current visualization, clear it first if (playerData.currentVisualization != null) { Visualization.Revert(player); } //if he's online, create a task to send him the visualization if (player.isOnline() && visualization.elements.size() > 0 && visualization.elements.get(0).location.getWorld().equals(player.getWorld())) { GriefPrevention.instance.getServer().getScheduler().scheduleSyncDelayedTask(GriefPrevention.instance, new VisualizationApplicationTask(player, playerData, visualization), 1L); } } //reverts a visualization by sending another block change list, this time with the real world block values public static void Revert(Player player) { if (!player.isOnline()) return; PlayerData playerData = GriefPrevention.instance.dataStore.getPlayerData(player.getUniqueId()); Visualization visualization = playerData.currentVisualization; if (playerData.currentVisualization != null) { //locality int minx = player.getLocation().getBlockX() - 100; int minz = player.getLocation().getBlockZ() - 100; int maxx = player.getLocation().getBlockX() + 100; int maxz = player.getLocation().getBlockZ() + 100; //remove any elements which are too far away visualization.removeElementsOutOfRange(visualization.elements, minx, minz, maxx, maxz); //send real block information for any remaining elements for (int i = 0; i < visualization.elements.size(); i++) { VisualizationElement element = visualization.elements.get(i); //check player still in world where visualization exists if (i == 0) { if (!player.getWorld().equals(element.location.getWorld())) return; } player.sendBlockChange(element.location, element.realBlock); } playerData.currentVisualization = null; } } //convenience method to build a visualization from a claim //visualizationType determines the style (gold blocks, silver, red, diamond, etc) public static Visualization FromClaim(Claim claim, int height, VisualizationType visualizationType, Location locality) { //visualize only top level claims if (claim.parent != null) { return FromClaim(claim.parent, height, visualizationType, locality); } Visualization visualization = new Visualization(); //add subdivisions first for (int i = 0; i < claim.children.size(); i++) { Claim child = claim.children.get(i); if (!child.inDataStore) continue; visualization.addClaimElements(child, height, VisualizationType.Subdivision, locality); } //special visualization for administrative land claims if (claim.isAdminClaim() && visualizationType == VisualizationType.Claim) { visualizationType = VisualizationType.AdminClaim; } //add top level last so that it takes precedence (it shows on top when the child claim boundaries overlap with its boundaries) visualization.addClaimElements(claim, height, visualizationType, locality); return visualization; } //adds a claim's visualization to the current visualization //handy for combining several visualizations together, as when visualization a top level claim with several subdivisions inside //locality is a performance consideration. only create visualization blocks for around 100 blocks of the locality public void addClaimElements(Claim claim, int height, VisualizationType visualizationType, Location locality) { BlockData cornerBlockData; BlockData accentBlockData; if (visualizationType == VisualizationType.Claim) { cornerBlockData = Material.GLOWSTONE.createBlockData(); accentBlockData = Material.GOLD_BLOCK.createBlockData(); } else if (visualizationType == VisualizationType.AdminClaim) { cornerBlockData = Material.GLOWSTONE.createBlockData(); accentBlockData = Material.PUMPKIN.createBlockData(); } else if (visualizationType == VisualizationType.Subdivision) { cornerBlockData = Material.IRON_BLOCK.createBlockData(); accentBlockData = Material.WHITE_WOOL.createBlockData(); } else if (visualizationType == VisualizationType.RestoreNature) { cornerBlockData = Material.DIAMOND_BLOCK.createBlockData(); accentBlockData = Material.DIAMOND_BLOCK.createBlockData(); } else { cornerBlockData = Material.REDSTONE_ORE.createBlockData(); ((Lightable) cornerBlockData).setLit(true); accentBlockData = Material.NETHERRACK.createBlockData(); } addClaimElements(claim.getLesserBoundaryCorner(), claim.getGreaterBoundaryCorner(), locality, height, cornerBlockData, accentBlockData, 10); } //adds a general claim cuboid (represented by min and max) visualization to the current visualization public void addClaimElements(Location min, Location max, Location locality, int height, BlockData cornerBlockData, BlockData accentBlockData, int STEP) { World world = min.getWorld(); boolean waterIsTransparent = locality.getBlock().getType() == Material.WATER; int smallx = min.getBlockX(); int smallz = min.getBlockZ(); int bigx = max.getBlockX(); int bigz = max.getBlockZ(); ArrayList newElements = new ArrayList<>(); //initialize visualization elements without Y values and real data //that will be added later for only the visualization elements within visualization range //locality int minx = locality.getBlockX() - 75; int minz = locality.getBlockZ() - 75; int maxx = locality.getBlockX() + 75; int maxz = locality.getBlockZ() + 75; //top line newElements.add(new VisualizationElement(new Location(world, smallx, 0, bigz), cornerBlockData, Material.AIR.createBlockData())); newElements.add(new VisualizationElement(new Location(world, smallx + 1, 0, bigz), accentBlockData, Material.AIR.createBlockData())); for (int x = smallx + STEP; x < bigx - STEP / 2; x += STEP) { if (x > minx && x < maxx) newElements.add(new VisualizationElement(new Location(world, x, 0, bigz), accentBlockData, Material.AIR.createBlockData())); } newElements.add(new VisualizationElement(new Location(world, bigx - 1, 0, bigz), accentBlockData, Material.AIR.createBlockData())); //bottom line newElements.add(new VisualizationElement(new Location(world, smallx + 1, 0, smallz), accentBlockData, Material.AIR.createBlockData())); for (int x = smallx + STEP; x < bigx - STEP / 2; x += STEP) { if (x > minx && x < maxx) newElements.add(new VisualizationElement(new Location(world, x, 0, smallz), accentBlockData, Material.AIR.createBlockData())); } newElements.add(new VisualizationElement(new Location(world, bigx - 1, 0, smallz), accentBlockData, Material.AIR.createBlockData())); //left line newElements.add(new VisualizationElement(new Location(world, smallx, 0, smallz), cornerBlockData, Material.AIR.createBlockData())); newElements.add(new VisualizationElement(new Location(world, smallx, 0, smallz + 1), accentBlockData, Material.AIR.createBlockData())); for (int z = smallz + STEP; z < bigz - STEP / 2; z += STEP) { if (z > minz && z < maxz) newElements.add(new VisualizationElement(new Location(world, smallx, 0, z), accentBlockData, Material.AIR.createBlockData())); } newElements.add(new VisualizationElement(new Location(world, smallx, 0, bigz - 1), accentBlockData, Material.AIR.createBlockData())); //right line newElements.add(new VisualizationElement(new Location(world, bigx, 0, smallz), cornerBlockData, Material.AIR.createBlockData())); newElements.add(new VisualizationElement(new Location(world, bigx, 0, smallz + 1), accentBlockData, Material.AIR.createBlockData())); for (int z = smallz + STEP; z < bigz - STEP / 2; z += STEP) { if (z > minz && z < maxz) newElements.add(new VisualizationElement(new Location(world, bigx, 0, z), accentBlockData, Material.AIR.createBlockData())); } newElements.add(new VisualizationElement(new Location(world, bigx, 0, bigz - 1), accentBlockData, Material.AIR.createBlockData())); newElements.add(new VisualizationElement(new Location(world, bigx, 0, bigz), cornerBlockData, Material.AIR.createBlockData())); //remove any out of range elements this.removeElementsOutOfRange(newElements, minx, minz, maxx, maxz); //remove any elements outside the claim BoundingBox box = BoundingBox.of(min, max); for (int i = 0; i < newElements.size(); i++) { VisualizationElement element = newElements.get(i); if (!containsIncludingIgnoringHeight(box, element.location.toVector())) { newElements.remove(i--); } } //set Y values and real block information for any remaining visualization blocks for (VisualizationElement element : newElements) { Location tempLocation = element.location; element.location = getVisibleLocation(tempLocation.getWorld(), tempLocation.getBlockX(), height, tempLocation.getBlockZ(), waterIsTransparent); height = element.location.getBlockY(); element.realBlock = element.location.getBlock().getBlockData(); } this.elements.addAll(newElements); } private boolean containsIncludingIgnoringHeight(BoundingBox box, Vector vector) { return vector.getBlockX() >= box.getMinX() && vector.getBlockX() <= box.getMaxX() && vector.getBlockZ() >= box.getMinZ() && vector.getBlockZ() <= box.getMaxZ(); } //removes any elements which are out of visualization range private void removeElementsOutOfRange(ArrayList elements, int minx, int minz, int maxx, int maxz) { for (int i = 0; i < elements.size(); i++) { Location location = elements.get(i).location; if (location.getX() < minx || location.getX() > maxx || location.getZ() < minz || location.getZ() > maxz) { elements.remove(i--); } } } //finds a block the player can probably see. this is how visualizations "cling" to the ground or ceiling private static Location getVisibleLocation(World world, int x, int y, int z, boolean waterIsTransparent) { Block block = world.getBlockAt(x, y, z); BlockFace direction = (isTransparent(block, waterIsTransparent)) ? BlockFace.DOWN : BlockFace.UP; while (block.getY() >= 1 && block.getY() < world.getMaxHeight() - 1 && (!isTransparent(block.getRelative(BlockFace.UP), waterIsTransparent) || isTransparent(block, waterIsTransparent))) { block = block.getRelative(direction); } return block.getLocation(); } //helper method for above. allows visualization blocks to sit underneath partly transparent blocks like grass and fence private static boolean isTransparent(Block block, boolean waterIsTransparent) { Material blockMaterial = block.getType(); //Blacklist switch (blockMaterial) { case SNOW: return false; } //Whitelist TODO: some of this might already be included in isTransparent() switch (blockMaterial) { case AIR: case OAK_FENCE: case ACACIA_FENCE: case BIRCH_FENCE: case DARK_OAK_FENCE: case JUNGLE_FENCE: case NETHER_BRICK_FENCE: case SPRUCE_FENCE: case OAK_FENCE_GATE: case ACACIA_FENCE_GATE: case BIRCH_FENCE_GATE: case DARK_OAK_FENCE_GATE: case SPRUCE_FENCE_GATE: case JUNGLE_FENCE_GATE: return true; } if (Tag.SIGNS.isTagged(blockMaterial) || Tag.WALL_SIGNS.isTagged(blockMaterial)) return true; return (waterIsTransparent && block.getType() == Material.WATER) || block.getType().isTransparent(); } public static Visualization fromClaims(Iterable claims, int height, VisualizationType type, Location locality) { Visualization visualization = new Visualization(); for (Claim claim : claims) { visualization.addClaimElements(claim, height, type, locality); } return visualization; } }