NoCheatPlus/NCPCore/src/main/java/fr/neatmonster/nocheatplus/utilities/map/BlockProperties.java

4874 lines
177 KiB
Java

/*
* 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 <http://www.gnu.org/licenses/>.
*/
package fr.neatmonster.nocheatplus.utilities.map;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.InputMismatchException;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.block.Block;
import org.bukkit.block.BlockFace;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.potion.PotionEffectType;
import fr.neatmonster.nocheatplus.NCPAPIProvider;
import fr.neatmonster.nocheatplus.checks.moving.util.MovingUtil;
import fr.neatmonster.nocheatplus.compat.AlmostBoolean;
import fr.neatmonster.nocheatplus.compat.Bridge1_9;
import fr.neatmonster.nocheatplus.compat.BridgeMaterial;
import fr.neatmonster.nocheatplus.compat.MCAccess;
import fr.neatmonster.nocheatplus.compat.blocks.BlockPropertiesSetup;
import fr.neatmonster.nocheatplus.compat.blocks.init.BlockInit;
import fr.neatmonster.nocheatplus.compat.blocks.init.vanilla.VanillaBlocksFactory;
import fr.neatmonster.nocheatplus.components.registry.event.IHandle;
import fr.neatmonster.nocheatplus.config.ConfPaths;
import fr.neatmonster.nocheatplus.config.RawConfigFile;
import fr.neatmonster.nocheatplus.config.WorldConfigProvider;
import fr.neatmonster.nocheatplus.logging.LogManager;
import fr.neatmonster.nocheatplus.logging.StaticLog;
import fr.neatmonster.nocheatplus.logging.Streams;
import fr.neatmonster.nocheatplus.utilities.PotionUtil;
import fr.neatmonster.nocheatplus.utilities.StringUtil;
import fr.neatmonster.nocheatplus.utilities.collision.BlockPositionContainer;
import fr.neatmonster.nocheatplus.utilities.collision.ICollidePassable;
import fr.neatmonster.nocheatplus.utilities.collision.PassableAxisTracing;
import fr.neatmonster.nocheatplus.utilities.collision.PassableRayTracing;
import fr.neatmonster.nocheatplus.utilities.location.PlayerLocation;
import fr.neatmonster.nocheatplus.utilities.map.BlockCache.IBlockCacheNode;
/**
* Properties of blocks.
*
* Likely to be added:
* - reading (all) properties from files.
* - reading (all) the default properties from a file too.
*
*/
@SuppressWarnings("deprecation")
public class BlockProperties {
/**
* The Enum ToolType.
*
* @author mc_dev
* @deprecated Will be replaced by a generic way to define tools.
*/
public static enum ToolType{
/** The none. */
NONE,
/** The sword. */
SWORD,
/** The shears. */
SHEARS,
/** The spade. */
SPADE,
/** The axe. */
AXE,
/** The pickaxe. */
PICKAXE,
// HOE,
}
/**
* The Enum MaterialBase.
*
* @author mc_dev
* @deprecated Will be replaced by a generic way to define tools.
*/
public static enum MaterialBase{
/** The none. */
NONE(0, 1f),
/** The wood. */
WOOD(1, 2f),
/** The stone. */
STONE(2, 4f),
/** The iron. */
IRON(3, 6f),
/** The diamond. */
DIAMOND(4, 8f),
/** The gold. */
GOLD(5, 12f);
/** Index for array. */
public final int index;
/** The break multiplier. */
public final float breakMultiplier;
/**
* Instantiates a new material base.
*
* @param index
* the index
* @param breakMultiplier
* the break multiplier
*/
private MaterialBase(int index, float breakMultiplier) {
this.index = index;
this.breakMultiplier = breakMultiplier;
}
/**
* Gets the by id.
*
* @param id
* the id
* @return the by id
* @deprecated Nothing to do with ids.
*/
@Deprecated
public static final MaterialBase getById(final int id) {
return getByIndex(id);
}
/**
* Get the index of this base material within the relevant materials or
* breaking times array.
*
* @param index
* @return
*/
public static final MaterialBase getByIndex(final int index) {
for (final MaterialBase base : MaterialBase.values()) {
if (base.index == index) {
return base;
}
}
throw new IllegalArgumentException("Bad index: " + index);
}
}
/**
* Properties of a tool.
*
* @deprecated Will be replaced by a generic way to define tools.
*/
public static class ToolProps{
/** The tool type. */
public final ToolType toolType;
/** The material base. */
public final MaterialBase materialBase;
/**
* Instantiates a new tool props.
*
* @param toolType
* the tool type
* @param materialBase
* the material base
*/
public ToolProps(ToolType toolType, MaterialBase materialBase) {
this.toolType = toolType;
this.materialBase = materialBase;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public String toString() {
return "ToolProps("+toolType + "/"+materialBase+")";
}
/**
* Validate.
*/
public void validate() {
if (toolType == null) {
throw new IllegalArgumentException("ToolType must not be null.");
}
if (materialBase == null) {
throw new IllegalArgumentException("MaterialBase must not be null");
}
}
}
/**
* Properties of a block.
*
* @deprecated Will be replaced by a generic way to define tools.
*/
public static class BlockProps{
/** The tool. */
public final ToolProps tool;
/** The breaking times. */
public final long[] breakingTimes;
/** The hardness. */
public final float hardness;
/** Factor 2 = 2 times faster. */
public final float efficiencyMod;
/**
* Instantiates a new block props.
*
* @param tool
* The tool type that allows access to breaking times other
* than MaterialBase.NONE.
* @param hardness
* the hardness
*/
public BlockProps(ToolProps tool, float hardness) {
this(tool, hardness, 1);
}
/**
* Instantiates a new block props.
*
* @param tool
* The tool type that allows access to breaking times other
* than MaterialBase.NONE.
* @param hardness
* the hardness
* @param efficiencyMod
* the efficiency mod
*/
public BlockProps(ToolProps tool, float hardness, float efficiencyMod) {
this.tool = tool;
this.hardness = hardness;
breakingTimes = new long[6];
for (int i = 0; i < 6; i++) {
final float multiplier;
if (tool.materialBase == null) {
multiplier = 1f;
}
else if (i < tool.materialBase.index) {
multiplier = 1f;
}
else {
multiplier = MaterialBase.getById(i).breakMultiplier * 3.33f;
}
breakingTimes[i] = (long) (1000f * 5f * hardness / multiplier);
}
this.efficiencyMod = efficiencyMod;
}
/**
* Instantiates a new block props.
*
* @param tool
* The tool type that allows access to breaking times other
* than MaterialBase.NONE.
* @param hardness
* the hardness
* @param breakingTimes
* The breaking times (NONE, WOOD, STONE, IRON, DIAMOND,
* GOLD)
*/
public BlockProps(ToolProps tool, float hardness, long[] breakingTimes) {
this(tool, hardness, breakingTimes, 1f);
}
/**
* Instantiates a new block props.
*
* @param tool
* The tool type that allows access to breaking times other
* than MaterialBase.NONE.
* @param hardness
* the hardness
* @param breakingTimes
* The breaking times (NONE, WOOD, STONE, IRON, DIAMOND,
* GOLD)
* @param efficiencyMod
* the efficiency mod
*/
public BlockProps(ToolProps tool, float hardness, long[] breakingTimes, float efficiencyMod) {
this.tool = tool;
this.breakingTimes = breakingTimes;
this.hardness = hardness;
this.efficiencyMod = efficiencyMod;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public String toString() {
return "BlockProps(" + hardness + " / " + tool.toString() + " / " + Arrays.toString(breakingTimes) + ")";
}
/**
* Validate.
*/
public void validate() {
if (breakingTimes == null) {
throw new IllegalArgumentException("Breaking times must not be null.");
}
if (breakingTimes.length != 6) {
throw new IllegalArgumentException("Breaking times length must match the number of available tool types (6).");
}
if (tool == null) {
throw new IllegalArgumentException("Tool must not be null.");
}
tool.validate();
}
}
/**
* Key for the specific block breaking time override table, mapping to the
* breaking time. Aim at configuration defaults, stating the more or less
* exact side conditions.
*
* @author asofold
*
*/
public static class BlockBreakKey {
private Material blockType = null;
@SuppressWarnings("unused")
private ToolType toolType = null;
@SuppressWarnings("unused")
private MaterialBase materialBase = null;
/** Efficiency enchantment. */
private Integer efficiency = null;
// TODO: Thinkable: head in liquid, attributes, player enchantments.
// TODO: SHOULD: Read from config.
/*
* TODO: COULD: add support for a command to auto track these entries
* and create config entries automatically. Should change methods to use
* this class as input (best with full side conditions).
*/
/**
* Empty constructor, no properties set.
*/
public BlockBreakKey() {
}
/**
* Copy constructor.
*
* @param key
*/
public BlockBreakKey(BlockBreakKey key) {
blockType = key.blockType;
toolType = key.toolType;
materialBase = key.materialBase;
efficiency = key.efficiency;
}
public BlockBreakKey blockType(Material blockType) {
this.blockType = blockType;
return this;
}
public Material blockType() {
return blockType;
}
public BlockBreakKey toolType(ToolType toolType) {
this.toolType = toolType;
return this;
}
public ToolType toolType() {
return toolType;
}
public BlockBreakKey materialBase(MaterialBase materialBase) {
this.materialBase = materialBase;
return this;
}
public MaterialBase materialBase() {
return materialBase;
}
public BlockBreakKey efficiency(int efficiency) {
this.efficiency = efficiency;
return this;
}
public int efficiency() {
return efficiency;
}
/**
* Add properties defined in a (config line of) string.
*
* @param def
* @return
* @throws All sorts of exceptions (number format, enum constants, runtime).
*/
public BlockBreakKey fromString(String def) {
String[] parts = def.split(":");
// First fully parse:
if (parts.length != 4) {
throw new IllegalArgumentException("Accept key definition with 4 parts only, input: " + def);
}
Material blockType = Material.matchMaterial(parts[0]);
ToolType toolType = ToolType.valueOf(parts[1].toUpperCase());
MaterialBase materialBase = MaterialBase.valueOf(parts[2].toUpperCase());
int efficiency = Integer.parseInt(parts[3]);
return this
.blockType(blockType)
.toolType(toolType)
.materialBase(materialBase)
.efficiency(efficiency);
}
@Override
public int hashCode() {
// TODO: ...
return (blockType == null ? 0 : blockType.hashCode() * 11)
^ (toolType == null ? 0 : toolType.hashCode() * 137)
^ (materialBase == null ? 0 : materialBase.hashCode() * 1193)
^ (efficiency == null ? 0 : efficiency.hashCode() * 12791);
}
@Override
public boolean equals(final Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof BlockBreakKey) {
final BlockBreakKey other = (BlockBreakKey) obj;
// TODO: Some should be equals later.
return blockType == other.blockType
&& efficiency == other.efficiency // fastest first.
&& toolType == other.toolType
&& materialBase == other.materialBase;
}
return false;
}
@Override
public String toString() {
return "BlockBreakKey(blockType=" + blockType + "toolType=" + toolType + "materialBase=" + materialBase + " efficiency=" + efficiency + ")";
}
}
/** Liquid height if no solid/full blocks are above. */
protected static final double LIQUID_HEIGHT_LOWERED = 80000002;
/** Properties by block type.*/
protected static final Map<Material, BlockProps> blocks = new HashMap<Material, BlockProps>();
/** Map for the tool properties. */
protected static Map<Material, ToolProps> tools = new LinkedHashMap<Material, ToolProps>(50, 0.5f);
/**
* Direct overrides for specific side conditions.
*/
private static Map<BlockBreakKey, Long> breakingTimeOverrides = new HashMap<BlockProperties.BlockBreakKey, Long>();
/** Breaking time for indestructible materials. */
public static final long indestructible = Long.MAX_VALUE;
/** Default tool properties (inappropriate tool). */
public static final ToolProps noTool = new ToolProps(ToolType.NONE, MaterialBase.NONE);
/** The Constant woodSword. */
public static final ToolProps woodSword = new ToolProps(ToolType.SWORD, MaterialBase.WOOD);
/** The Constant woodSpade. */
public static final ToolProps woodSpade = new ToolProps(ToolType.SPADE, MaterialBase.WOOD);
/** The Constant woodPickaxe. */
public static final ToolProps woodPickaxe = new ToolProps(ToolType.PICKAXE, MaterialBase.WOOD);
/** The Constant woodAxe. */
public static final ToolProps woodAxe = new ToolProps(ToolType.AXE, MaterialBase.WOOD);
/** The Constant stonePickaxe. */
public static final ToolProps stonePickaxe = new ToolProps(ToolType.PICKAXE, MaterialBase.STONE);
/** The Constant ironPickaxe. */
public static final ToolProps ironPickaxe = new ToolProps(ToolType.PICKAXE, MaterialBase.IRON);
/** The Constant diamondPickaxe. */
public static final ToolProps diamondPickaxe = new ToolProps(ToolType.PICKAXE, MaterialBase.DIAMOND);
/** Times for instant breaking. */
public static final long[] instantTimes = secToMs(0);
/** The Constant leafTimes. */
public static final long[] leafTimes = secToMs(0.3);
/** The glass times. */
public static long[] glassTimes = secToMs(0.45);
/** The Constant gravelTimes. */
public static final long[] gravelTimes = secToMs(0.9, 0.45, 0.25, 0.15, 0.15, 0.1);
/** The rails times. */
public static long[] railsTimes = secToMs(1.05, 0.55, 0.3, 0.2, 0.15, 0.1);
/** The Constant woodTimes. */
public static final long[] woodTimes = secToMs(3, 1.5, 0.75, 0.5, 0.4, 0.25);
/** The Constant indestructibleTimes. */
private static final long[] indestructibleTimes = new long[] {indestructible, indestructible, indestructible, indestructible, indestructible, indestructible};
/** Instantly breakable. */
public static final BlockProps instantType = new BlockProps(noTool, 0, instantTimes);
/** The Constant glassType. */
public static final BlockProps glassType = new BlockProps(noTool, 0.3f, glassTimes, 2f);
/** The Constant gravelType. */
public static final BlockProps gravelType = new BlockProps(woodSpade, 0.6f, gravelTimes);
/** Stone type blocks. */
public static final BlockProps stoneType = new BlockProps(woodPickaxe, 1.5f);
/** The Constant woodType. */
public static final BlockProps woodType = new BlockProps(woodAxe, 2, woodTimes);
/** The Constant brickType. */
public static final BlockProps brickType = new BlockProps(woodPickaxe, 2);
/** The Constant coalType. */
public static final BlockProps coalType = new BlockProps(woodPickaxe, 3);
/** The Constant goldBlockType. */
public static final BlockProps goldBlockType = new BlockProps(woodPickaxe, 3, secToMs(15, 7.5, 3.75, 0.7, 0.55, 1.2));
/** The Constant ironBlockType. */
public static final BlockProps ironBlockType = new BlockProps(woodPickaxe, 5, secToMs(25, 12.5, 1.875, 1.25, 0.95, 2.0));
/** The Constant diamondBlockType. */
public static final BlockProps diamondBlockType = new BlockProps(woodPickaxe, 5, secToMs(25, 12.5, 6.0, 1.25, 0.95, 2.0));
/** The Constant hugeMushroomType. */
public static final BlockProps hugeMushroomType = new BlockProps(woodAxe, 0.2f, secToMs(0.3, 0.15, 0.1, 0.05, 0.05, 0.05));
/** The Constant leafType. */
public static final BlockProps leafType = new BlockProps(noTool, 0.2f, leafTimes);
/** The Constant sandType. */
public static final BlockProps sandType = new BlockProps(woodSpade, 0.5f, secToMs(0.75, 0.4, 0.2, 0.15, 0.1, 0.1));
/** The Constant leverType. */
public static final BlockProps leverType = new BlockProps(noTool, 0.5f, secToMs(0.75));
/** The Constant sandStoneType. */
public static final BlockProps sandStoneType = new BlockProps(woodPickaxe, 0.8f);
/** The Constant chestType. */
public static final BlockProps chestType = new BlockProps(woodAxe, 2.5f, secToMs(3.75, 1.9, 0.95, 0.65, 0.5, 0.35));
/** The Constant woodDoorType. */
public static final BlockProps woodDoorType = new BlockProps(woodAxe, 3.0f, secToMs(4.5, 2.25, 1.15, 0.75, 0.6, 0.4));
/** The Constant dispenserType. */
public static final BlockProps dispenserType = new BlockProps(woodPickaxe, 3.5f);
/** The Constant ironDoorType. */
public static final BlockProps ironDoorType = new BlockProps(woodPickaxe, 5);
/** The Constant indestructibleType. */
public static final BlockProps indestructibleType = new BlockProps(noTool, -1f, indestructibleTimes);
/** Returned if unknown. */
private static BlockProps defaultBlockProps = instantType;
/** The Constant instantMat. */
protected static final Material[] instantMat = new Material[]{
// Named in wiki.
BridgeMaterial.WHEAT_CROPS,
Material.TRIPWIRE_HOOK, Material.TRIPWIRE,
Material.TORCH,
Material.TNT,
BridgeMaterial.SUGAR_CANE,
BridgeMaterial.get("red_rose"), BridgeMaterial.DANDELION,
BridgeMaterial.get("blue_orchid"),
Material.REDSTONE_WIRE,
BridgeMaterial.get("REDSTONE_TORCH_ON"),
BridgeMaterial.get("REDSTONE_TORCH_OFF"),
BridgeMaterial.get("DIODE_BLOCK_ON"), BridgeMaterial.get("DIODE_BLOCK_OFF"),
BridgeMaterial.get("repeater"),
Material.PUMPKIN_STEM,
BridgeMaterial.getBlock("NETHER_WART"),
BridgeMaterial.getBlock("NETHER_WARTS"), // TODO: Bug or very old?
Material.BROWN_MUSHROOM, Material.RED_MUSHROOM,
Material.MELON_STEM,
BridgeMaterial.LILY_PAD,
BridgeMaterial.TALL_GRASS,
BridgeMaterial.GRASS,
Material.FIRE,
//
BridgeMaterial.WHEAT_CROPS,
// 1.4
BridgeMaterial.COMMAND_BLOCK,
BridgeMaterial.CARROTS,
BridgeMaterial.POTATOES,
// 1.13 /...
BridgeMaterial.get("allium"),
BridgeMaterial.get("azure_bluet"),
BridgeMaterial.get("dandelion"),
BridgeMaterial.getBlock("dandelion_yellow"),
BridgeMaterial.get("kelp_plant"),
BridgeMaterial.get("large_fern"),
BridgeMaterial.get("lilac"),
BridgeMaterial.get("oxeye_daisy"),
BridgeMaterial.get("peony"),
BridgeMaterial.get("poppy"),
BridgeMaterial.get("redstone_torch"),
BridgeMaterial.get("redstone_wall_torch"),
BridgeMaterial.getBlock("rose_red"),
BridgeMaterial.get("seagrass"),
BridgeMaterial.get("sea_pickle"),
BridgeMaterial.get("sunflower"),
BridgeMaterial.get("tall_seagrass"),
};
/** The rt ray. */
private static ICollidePassable rtRay = null;
/** The rt axis. */
private static ICollidePassable rtAxis = null;
/** The block cache. */
private static WrapBlockCache wrapBlockCache = null;
/** The p loc. */
private static PlayerLocation pLoc = null;
/** The Constant blockFlags. */
protected static final Map<Material, Long> blockFlags = new HashMap<Material, Long>();
/**
* Map flag to names.
*/
private static final Map<Long, String> flagNameMap = new LinkedHashMap<Long, String>();
/**
* Map flag name to flag, both names starting with F_... and the name
* without F_.
*/
private static final Map<String, Long> nameFlagMap = new LinkedHashMap<String, Long>();
private static long f_next = 1;
private static long f_flag() {
final long flag;
synchronized(BlockProperties.class) {
if (f_next <= 0L) {
throw new IllegalStateException("No more flags available.");
}
flag = f_next;
f_next *= 2L;
}
return flag;
}
/** Flag position for stairs. */
public static final long F_STAIRS = f_flag();
/** The Constant F_LIQUID. */
public static final long F_LIQUID = f_flag();
// TODO: maybe remove F_SOLID use (unless for setting F_GROUND on init).
/** Minecraft isSolid result. Used for setting ground flag - Subject to change / rename.*/
public static final long F_SOLID = f_flag();
/** Compatibility flag: regard this block as passable always. */
public static final long F_IGN_PASSABLE = f_flag();
/** The Constant F_WATER. */
public static final long F_WATER = f_flag();
/** The Constant F_LAVA. */
public static final long F_LAVA = f_flag();
/** Override bounding box: 1.5 blocks high, like fences.<br>
* NOTE: This might have relevance for passable later.
*/
public static final long F_HEIGHT150 = f_flag();
/** The player can stand on these, sneaking or not. */
public static final long F_GROUND = f_flag(); // TODO:
/** Override bounding box: 1 block height.<br>
* NOTE: This should later be ignored by passable, rather.
*/
public static final long F_HEIGHT100 = f_flag();
/** Climbable like ladder and vine (allow to land on without taking damage). */
public static final long F_CLIMBABLE = f_flag();
/** The block can change shape. This is most likely not 100% accurate... */
public static final long F_VARIABLE = f_flag();
// /** The block has full bounds (0..1), inaccurate! */
// public static final int F_FULL = 0x800;
/** Block has full xz-bounds. */
public static final long F_XZ100 = f_flag();
/**
* This flag indicates that everything between the minimum ground height and
* the height of the block can also be stood on. See
* {@link #getGroundMinHeight(BlockCache, int, int, int, IBlockCacheNode, long)}
* for minimum height.<br>
* In addition this flag directly triggers a passable workaround for
* otherwise colliding blocks
* ({@link #isPassableWorkaround(BlockCache, int, int, int, double, double, double, IBlockCacheNode, double, double, double, double)}).
*/
public static final long F_GROUND_HEIGHT = f_flag();
/**
* The height is assumed to decrease from 1.0 with increasing data value from 0 to 0x7, with 0x7 being the lowest.
* (repeating till 0x15)). 0x8 means falling/full block. This is meant to model flowing water/lava. <br>
* However the hit-box for collision checks will be set to 0.5 height or 1.0 height only.
*/
public static final long F_HEIGHT_8SIM_DEC = f_flag();
/**
* The height is assumed to increase with data value up to 0x7, repeating up to 0x15.<br>
* However the hit-box for collision checks will be set to 0.5 height or 1.0 height only,<br>
* as with the 1.4.x snow levels.
*/
public static final long F_HEIGHT_8SIM_INC = f_flag();
/**
* The height increases with data value (8 heights).<br>
* This is for MC 1.5 snow levels.
*/
public static final long F_HEIGHT_8_INC = f_flag();
/** All rail types a minecart can move on. */
public static final long F_RAILS = f_flag();
/** ICE. */
public static final long F_ICE = f_flag();
/** LEAVES. */
public static final long F_LEAVES = f_flag();
/** THIN FENCE (glass panes, iron fence). */
public static final long F_THIN_FENCE = f_flag();
/** Meta-flag to indicate that the (max.-) edges should mean a collision, can be passed to collidesBlock. */
public static final long F_COLLIDE_EDGES = f_flag();
/** Thick fence (default wooden fence). */
public static final long F_THICK_FENCE = f_flag();
/** Fence gate style with 0x04 being fully passable. */
public static final long F_PASSABLE_X4 = f_flag();
// TODO: Separate no fall damage flag ? [-> on ground could return "dominating" flags, or extra flags]
/** Like slime block: bounce back 25% of fall height without taking fall damage [TODO: Check/adjust]. */
public static final long F_BOUNCE25 = f_flag();
/**
* The facing direction is described by the lower 3 data bits in order of
* NSWE, starting at and defaulting to 2, which includes invalid states.
* Main purpose is ladders, no guarantees on defaults for other blocks yet.
*/
public static final long F_FACING_LOW3D2_NSWE = f_flag();
/**
* The direction the block is attached to is described by the lower 2 bits
* in order of SNEW.
*/
public static final long F_ATTACHED_LOW2_SNEW = f_flag();
/**
* The hacky way to force sfNoLowJump when the block at from has this flag.
*/
public static final long F_ALLOW_LOWJUMP = f_flag();
/** One eighth block height (0.125). */
public static final long F_HEIGHT8_1 = f_flag();
/**
* Fall distance is divided by 2, if a move goes through this medium
* (currently only supports liquid).
*/
public static final long F_FALLDIST_HALF = f_flag();
/**
* Fall distance is set to zero, if a move goes through this medium
* (currently only supports liquid).
*/
public static final long F_FALLDIST_ZERO = f_flag();
/**
* Minimum height 15/16 (0.9375 = 1 - 0.0625). <br>
* Only applies with F_GROUND_HEIGHT set.
*/
public static final long F_MIN_HEIGHT16_15 = f_flag();
/**
* Minimum height 1/16 (0.0625). <br>
* Only applies with F_GROUND_HEIGHT set.
*/
// TODO: Lily pad min height of MC versions?
public static final long F_MIN_HEIGHT16_1 = f_flag();
/** CARPET. **/
public static final long F_CARPET = f_flag();
/** Cobweb like blocks (adhesive). */
public static final long F_COBWEB = f_flag();
/**
* Block change tracking: ordinary right click interaction (use) can change
* the shape.
*/
public static final long F_VARIABLE_USE = f_flag();
/**
* Block change tracking: block redstone events can change the shape.
*/
public static final long F_VARIABLE_REDSTONE = f_flag();
/**
* BukkitModern model flag, set by MCAccessBukkitModern for routing, iff
* available.
*/
public static final long F_MODEL_SLAB = f_flag();
// TODO: Convenience constants combining all height / minheight flags.
// TODO: When flags are out, switch to per-block classes :p.
// Special case activation flags.
/** Trap door is climbable with ladder underneath, both facing distinct. */
private static boolean specialCaseTrapDoorAboveLadder = false;
/** The Constant useLoc. */
private static final Location useLoc = new Location(null, 0, 0, 0);
static{
// Use reflection to get a flag -> name mapping and vice versa.
synchronized(BlockProperties.class) {
for (Field field : BlockProperties.class.getDeclaredFields()) {
String name = field.getName();
if (name.startsWith("F_")) {
try {
Long value = field.getLong(BlockProperties.class);
if (flagNameMap.containsKey(value)) {
throw new IllegalStateException("Same value for flag names: " + name + " + " + flagNameMap.get(value));
}
flagNameMap.put(value, name.substring(2));
nameFlagMap.put(name, value);
nameFlagMap.put(name.substring(2), value);
} catch (IllegalArgumentException e) {
} catch (IllegalAccessException e) {
}
}
}
}
}
/** Penalty factor for block break duration if under water. */
protected static float breakPenaltyInWater = 4f;
/** Penalty factor for block break duration if not on ground. */
protected static float breakPenaltyOffGround = 4f;
/**
* Initialize blocks and tools properties. This can be called at any time
* during runtime.
*
* @param mcAccess
* If mcAccess implements BlockPropertiesSetup,
* mcAccess.setupBlockProperties will be called directly after
* basic initialization but before the configuration is applied.
* @param worldConfigProvider
* the world config provider
*/
public static void init(final IHandle<MCAccess> mcAccess,
final WorldConfigProvider<?> worldConfigProvider) {
wrapBlockCache = new WrapBlockCache();
rtRay = new PassableRayTracing();
rtAxis = new PassableAxisTracing();
pLoc = new PlayerLocation(mcAccess, null);
final Set<String> blocksFeatures = new LinkedHashSet<String>(); // getClass().getName() or some abstract.
try{
initTools(mcAccess, worldConfigProvider);
initBlocks(mcAccess, worldConfigProvider);
blocksFeatures.add("BlocksMC1_4");
// Extra hand picked setups.
try{
blocksFeatures.addAll(new VanillaBlocksFactory().setupVanillaBlocks(worldConfigProvider));
}
catch(Throwable t) {
StaticLog.logSevere("Could not initialize vanilla blocks: " + t.getClass().getSimpleName() + " - " + t.getMessage());
StaticLog.logSevere(t);
}
// Allow mcAccess to setup block properties.
final MCAccess handle = mcAccess.getHandle();
if (handle instanceof BlockPropertiesSetup) {
try{
((BlockPropertiesSetup) handle).setupBlockProperties(worldConfigProvider);
blocksFeatures.add(handle.getClass().getSimpleName());
}
catch(Throwable t) {
StaticLog.logSevere("McAccess.setupBlockProperties (" + handle.getClass().getSimpleName() + ") could not execute properly: " + t.getClass().getSimpleName() + " - " + t.getMessage());
StaticLog.logSevere(t);
}
}
// TODO: Add registry for further BlockPropertiesSetup instances.
}
catch(Throwable t) {
StaticLog.logSevere(t);
}
// Override feature tags for blocks.
NCPAPIProvider.getNoCheatPlusAPI().setFeatureTags("blocks", blocksFeatures);
}
/**
* Inits the tools.
*
* @param mcAccess
* the mc access
* @param worldConfigProvider
* the world config provider
*/
private static void initTools(final IHandle<MCAccess> mcAccess, final WorldConfigProvider<?> worldConfigProvider) {
tools.clear();
tools.put(BridgeMaterial.WOODEN_SWORD, new ToolProps(ToolType.SWORD, MaterialBase.WOOD));
tools.put(BridgeMaterial.WOODEN_SHOVEL, new ToolProps(ToolType.SPADE, MaterialBase.WOOD));
tools.put(BridgeMaterial.WOODEN_PICKAXE, new ToolProps(ToolType.PICKAXE, MaterialBase.WOOD));
tools.put(BridgeMaterial.WOODEN_AXE, new ToolProps(ToolType.AXE, MaterialBase.WOOD));
tools.put(Material.STONE_SWORD, new ToolProps(ToolType.SWORD, MaterialBase.STONE));
tools.put(BridgeMaterial.STONE_SHOVEL, new ToolProps(ToolType.SPADE, MaterialBase.STONE));
tools.put(Material.STONE_PICKAXE, new ToolProps(ToolType.PICKAXE, MaterialBase.STONE));
tools.put(Material.STONE_AXE, new ToolProps(ToolType.AXE, MaterialBase.STONE));
tools.put(Material.IRON_SWORD, new ToolProps(ToolType.SWORD, MaterialBase.IRON));
tools.put(BridgeMaterial.IRON_SHOVEL, new ToolProps(ToolType.SPADE, MaterialBase.IRON));
tools.put(Material.IRON_PICKAXE, new ToolProps(ToolType.PICKAXE, MaterialBase.IRON));
tools.put(Material.IRON_AXE, new ToolProps(ToolType.AXE, MaterialBase.IRON));
tools.put(Material.DIAMOND_SWORD, new ToolProps(ToolType.SWORD, MaterialBase.DIAMOND));
tools.put(BridgeMaterial.DIAMOND_SHOVEL, new ToolProps(ToolType.SPADE, MaterialBase.DIAMOND));
tools.put(Material.DIAMOND_PICKAXE, new ToolProps(ToolType.PICKAXE, MaterialBase.DIAMOND));
tools.put(Material.DIAMOND_AXE, new ToolProps(ToolType.AXE, MaterialBase.DIAMOND));
tools.put(BridgeMaterial.GOLDEN_SWORD, new ToolProps(ToolType.SWORD, MaterialBase.GOLD));
tools.put(BridgeMaterial.GOLDEN_SHOVEL, new ToolProps(ToolType.SPADE, MaterialBase.GOLD));
tools.put(BridgeMaterial.GOLDEN_PICKAXE, new ToolProps(ToolType.PICKAXE, MaterialBase.GOLD));
tools.put(BridgeMaterial.GOLDEN_AXE, new ToolProps(ToolType.AXE, MaterialBase.GOLD));
tools.put(Material.SHEARS, new ToolProps(ToolType.SHEARS, MaterialBase.NONE));
}
private static void setFlag(Material material, long addFlag) {
if (!material.isBlock()) {
// Let's not fail hard here.
StaticLog.logWarning("Attempt to set flag for a non-block: " + material);
}
blockFlags.put(material, blockFlags.get(material) | addFlag);
}
private static void maskFlag(Material material, long addFlag) {
if (!material.isBlock()) {
// Let's not fail hard here.
StaticLog.logWarning("Attempt to mask flag for a non-block: " + material);
}
blockFlags.put(material, blockFlags.get(material) & addFlag);
}
private static void setBlock(Material material, BlockProps props) {
if (!material.isBlock()) {
// Let's not fail hard here.
StaticLog.logWarning("Attempt to set block breaking properties for a non-block: " + material);
}
blocks.put(material, props);
}
/**
* Inits the blocks.
*
* @param mcAccessHandle
* the mc access handle
* @param worldConfigProvider
* the world config provider
*/
private static void initBlocks(final IHandle<MCAccess> mcAccessHandle, final WorldConfigProvider<?> worldConfigProvider) {
final MCAccess mcAccess = mcAccessHandle.getHandle();
// Reset tool props.
blocks.clear();
// Initialize block flags
// Generic initialization.
for (Material mat : Material.values()) {
blockFlags.put(mat, 0L);
if (mcAccess.isBlockLiquid(mat).decide()) {
// TODO: do not set F_GROUND for liquids ?
setFlag(mat, F_LIQUID);
if (mcAccess.isBlockSolid(mat).decide()) setFlag(mat, F_SOLID);
}
else if (mcAccess.isBlockSolid(mat).decide()) {
setFlag(mat, F_SOLID | F_GROUND);
}
}
BlockProps props;
// Stairs.
final long stairFlags = F_STAIRS | F_HEIGHT100 | F_XZ100 | F_GROUND | F_GROUND_HEIGHT;
for (final Material mat : new Material[] {
Material.NETHER_BRICK_STAIRS, Material.COBBLESTONE_STAIRS,
BridgeMaterial.STONE_BRICK_STAIRS,
Material.BRICK_STAIRS, Material.SANDSTONE_STAIRS,
}) {
setFlag(mat, stairFlags);
}
for (final Material mat : MaterialUtil.WOODEN_STAIRS) {
setFlag(mat, stairFlags);
}
// Step (ground + full width).
final long stepFlags = F_GROUND | F_XZ100;
for (final Material mat : new Material[]{
BridgeMaterial.STONE_SLAB,
}) {
setFlag(mat, stepFlags);
}
for (final Material mat : MaterialUtil.WOODEN_SLABS) {
setFlag(mat, stepFlags);
}
// Rails
for (final Material mat : MaterialUtil.RAILS) {
setFlag(mat, F_RAILS);
}
// WATER.
for (final Material mat : MaterialUtil.WATER) {
setFlag(mat, F_LIQUID | F_HEIGHT_8SIM_DEC | F_WATER | F_FALLDIST_ZERO);
}
// LAVA.
for (final Material mat : MaterialUtil.LAVA) {
setFlag(mat, F_LIQUID | F_HEIGHT_8SIM_DEC | F_LAVA | F_FALLDIST_HALF);
}
// Snow (1.4.x)
setFlag(Material.SNOW, F_HEIGHT_8SIM_INC);
// Climbable
for (final Material mat : new Material[]{
Material.VINE, Material.LADDER,
}) {
setFlag(mat, F_CLIMBABLE);
}
// Workarounds.
// Ground (can stand on).
for (final Material mat : new Material[]{
BridgeMaterial.LILY_PAD, Material.LADDER,
BridgeMaterial.get("DIODE_BLOCK_OFF"),
BridgeMaterial.get("DIODE_BLOCK_ON"),
Material.COCOA, Material.SNOW, Material.BREWING_STAND,
BridgeMaterial.PISTON_HEAD,
BridgeMaterial.STONE_SLAB,
}) {
if (mat != null) {
setFlag(mat, F_GROUND);
}
}
setBlockProps(BridgeMaterial.MOVING_PISTON, indestructibleType); // TODO: really?
setFlag(BridgeMaterial.MOVING_PISTON, F_IGN_PASSABLE | F_GROUND | F_GROUND_HEIGHT
| BlockFlags.FULL_BOUNDS);
// Full block height.
for (final Material mat : new Material[]{
// BridgeMaterial.END_PORTAL_FRAME,
Material.BREWING_STAND,
BridgeMaterial.PISTON_HEAD,
BridgeMaterial.FARMLAND, // Server reports the visible shape 0.9375, client moves on full block height.
}) {
setFlag(mat, F_HEIGHT100);
}
// Full width/xz-bounds.
for (final Material mat : new Material[]{
BridgeMaterial.PISTON_HEAD,
BridgeMaterial.END_PORTAL_FRAME
}) {
setFlag(mat, F_XZ100);
}
// ICE
setFlag(Material.ICE, F_ICE);
// Not ground (!).
for (final Material mat : new Material[]{
Material.WALL_SIGN, BridgeMaterial.SIGN,
}) {
// TODO: Might keep solid since it is meant to be related to block shapes rather ("original mc value").
maskFlag(mat, ~(F_GROUND | F_SOLID));
}
// Ignore for passable.
for (final Material mat : new Material[]{
// More strictly needed.
BridgeMaterial.STONE_PRESSURE_PLATE,
Material.WALL_SIGN, BridgeMaterial.SIGN,
BridgeMaterial.get("DIODE_BLOCK_ON"),
BridgeMaterial.get("DIODE_BLOCK_OFF"),
Material.BREWING_STAND,
// Compatibility.
Material.LADDER,
// Somewhat needed (xz-bounds vary, not critical to pass through).
BridgeMaterial.CAKE,
// Workarounds.
// Material.COCOA,
}) {
if (mat != null) {
setFlag(mat, F_IGN_PASSABLE);
}
}
for (final Material mat : MaterialUtil.WOODEN_PRESSURE_PLATES) {
setFlag(mat, F_IGN_PASSABLE);
}
// ? Extra flag for COCOA, ANVIL: depends on data value (other issue)
// Fences, 1.5 block high.
final long flags150 = F_HEIGHT150 | F_VARIABLE | F_THICK_FENCE;
for (final Material mat : new Material[]{
BridgeMaterial.NETHER_BRICK_FENCE,
BridgeMaterial.COBBLESTONE_WALL,
}) {
setFlag(mat, flags150);
}
for (final Material mat : MaterialUtil.WOODEN_FENCES) {
setFlag(mat, flags150);
}for (final Material mat : MaterialUtil.WOODEN_FENCE_GATES) {
setFlag(mat, flags150);
}
// F_PASSABLE_X4
// TODO: PASSABLE_X4 is abused for other checks, need another one?
for (final Material mat : MaterialUtil.WOODEN_FENCE_GATES) {
setFlag(mat, F_PASSABLE_X4);
}
for (final Material mat : MaterialUtil.WOODEN_TRAP_DOORS) {
setFlag(mat, F_PASSABLE_X4);
}
// F_VARIABLE_REDSTONE, F_VARIABLE_USE
// TODO: Use collections.
for (Material material : Material.values()) {
if (material.isBlock()) {
final String name = material.name().toLowerCase();
if (name.endsWith("_door")
|| name.endsWith("_trapdoor")
|| name.endsWith("fence_gate")) {
setFlag(material, F_VARIABLE_REDSTONE);
if (!name.contains("iron")) {
setFlag(material, F_VARIABLE_USE);
}
}
}
}
// F_FACING_LOW3D2_NSWE
for (final Material mat : new Material[]{
Material.LADDER
}) {
setFlag(mat, F_FACING_LOW3D2_NSWE);
}
// F_FACING_LOW2_SNEW
for (final Material mat : MaterialUtil.WOODEN_TRAP_DOORS) {
setFlag(mat, F_ATTACHED_LOW2_SNEW);
}
// Thin fences (iron fence, glass panes).
final long paneFlags = F_THIN_FENCE | F_VARIABLE;
for (final Material mat : new Material[]{
BridgeMaterial.IRON_BARS,
}) {
setFlag(mat, paneFlags);
}
for (final Material mat : MaterialUtil.GLASS_PANES) {
setFlag(mat, paneFlags);
}
// Flexible ground (height):
for (final Material mat : new Material[]{
// Strictly needed (multiple boxes otherwise).
BridgeMaterial.PISTON_HEAD,
Material.BREWING_STAND,
BridgeMaterial.END_PORTAL_FRAME,
// XZ-bounds issues.
BridgeMaterial.CAKE,
// Already worked around with isPassableWorkaround (kept for dev-reference).
// Material.ANVIL,
// Material.SKULL, Material.FLOWER_POT,
// Material.DRAGON_EGG,
// Material.COCOA,
// 1.10.2 +- client uses the reported height.
BridgeMaterial.FARMLAND,
}) {
setFlag(mat, F_GROUND_HEIGHT);
}
// Issues standing on with F_PASSABLE_X4. Note getGroundMinHeight.
for (Material mat : MaterialUtil.WOODEN_TRAP_DOORS) {
setFlag(mat, F_GROUND_HEIGHT);
}
// Set block break properties.
// Instantly breakable.
for (final Material mat : instantMat) {
if (mat != null) {
setBlock(mat, instantType);
}
}
@SuppressWarnings("unchecked")
List<Set<Material>> instantSets = Arrays.asList(
MaterialUtil.BUSHES, MaterialUtil.TULIPS,
MaterialUtil.SAPLINGS
);
for (final Set<Material> set : instantSets) {
for (final Material mat : set) {
setBlock(mat, instantType);
}
}
// Leaf type
for (final Material mat : MaterialUtil.LEAVES) {
setBlock(mat, leafType);
setFlag(mat, F_LEAVES);
}
for (Material mat : MaterialUtil.BEDS) { // TODO: Beds are special.
setBlock(mat, leafType);
}
// Cobweb
setFlag(BridgeMaterial.COBWEB, F_COBWEB);
// Huge mushroom type (...)
for (Material mat : new Material[]{
Material.VINE, Material.COCOA}) {
setBlock(mat, hugeMushroomType);
}
for (Material mat : MaterialUtil.MUSHROOM_BLOCKS) {
setBlock(mat, hugeMushroomType);
}
setBlock(Material.SNOW, new BlockProps(getToolProps(BridgeMaterial.WOODEN_SHOVEL), 0.1f, secToMs(0.5, 0.1, 0.05, 0.05, 0.05, 0.05)));
setBlock(Material.SNOW_BLOCK, new BlockProps(getToolProps(BridgeMaterial.WOODEN_SHOVEL), 0.1f, secToMs(1, 0.15, 0.1, 0.05, 0.05, 0.05)));
for (Material mat : new Material[]{
BridgeMaterial.get("REDSTONE_LAMP_ON"),
BridgeMaterial.get("REDSTONE_LAMP_OFF"),
BridgeMaterial.get("REDSTONE_LAMP"),
Material.GLOWSTONE,
}) {
if (mat != null) {
setBlock(mat, glassType);
}
}
for (final Material mat : MaterialUtil.GLASS_BLOCKS) {
setBlock(mat, glassType);
}
for (final Material mat : MaterialUtil.GLASS_PANES) {
setBlock(mat, glassType);
}
setBlock(Material.NETHERRACK, new BlockProps(woodPickaxe, 0.4f, secToMs(2, 0.3, 0.15, 0.1, 0.1, 0.05)));
setBlock(Material.LADDER, new BlockProps(noTool, 0.4f, secToMs(0.6), 2.5f));
setBlock(Material.CACTUS, new BlockProps(noTool, 0.4f, secToMs(0.6)));
for (Material mat : MaterialUtil.WOODEN_PRESSURE_PLATES) {
setBlock(mat, new BlockProps(woodAxe, 0.5f, secToMs(0.75, 0.4, 0.2, 0.15, 0.1, 0.1)));
}
setBlock(BridgeMaterial.STONE_PRESSURE_PLATE, new BlockProps(woodPickaxe, 0.5f, secToMs(2.5, 0.4, 0.2, 0.15, 0.1, 0.07)));
setBlock(Material.SAND, sandType);
setBlock(Material.SOUL_SAND, sandType);
for (Material mat: new Material[]{Material.LEVER, BridgeMaterial.PISTON,
BridgeMaterial.PISTON_HEAD, BridgeMaterial.STICKY_PISTON,
Material.STONE_BUTTON, BridgeMaterial.PISTON}) {
setBlock(mat, leverType);
}
// setBlock(Material.ICE, new BlockProps(woodPickaxe, 0.5f, secToMs(2.5, 0.4, 0.2, 0.15, 0.1, 0.1)));
setBlock(Material.ICE, new BlockProps(woodPickaxe, 0.5f, secToMs(0.7, 0.35, 0.18, 0.12, 0.09, 0.06 )));
setBlock(Material.DIRT, sandType);
setBlock(BridgeMaterial.CAKE, leverType);
setBlock(Material.BREWING_STAND, new BlockProps(woodPickaxe, 0.5f, secToMs(2.5, 0.4, 0.2, 0.15, 0.1, 0.1)));
setBlock(Material.SPONGE, new BlockProps(noTool, 0.6f, secToMs(0.9)));
for (Material mat : new Material[]{
BridgeMaterial.MYCELIUM, BridgeMaterial.FARMLAND,
Material.GRAVEL, BridgeMaterial.GRASS_BLOCK,
Material.CLAY,
}) {
setBlock(mat, gravelType);
}
for (Material mat : MaterialUtil.RAILS) {
setBlock(mat, new BlockProps(woodPickaxe, 0.7f, railsTimes));
}
for (Material mat : MaterialUtil.INFESTED_BLOCKS) {
setBlock(mat, new BlockProps(noTool, 0.75f, secToMs(1.15)));
}
for (Material mat : MaterialUtil.WOOD_BLOCKS) {
setBlock(mat, new BlockProps(noTool, 0.8f, secToMs(1.2), 3f));
}
setBlock(Material.SANDSTONE, sandStoneType);
setBlock(Material.SANDSTONE_STAIRS, sandStoneType);
for (Material mat : new Material[]{
Material.STONE, BridgeMaterial.STONE_BRICKS,
BridgeMaterial.STONE_BRICK_STAIRS,
}) {
setBlock(mat, stoneType);
}
setBlock(Material.NOTE_BLOCK, new BlockProps(woodAxe, 0.8f, secToMs(1.2, 0.6, 0.3, 0.2, 0.15, 0.1)));
final BlockProps pumpkinType = new BlockProps(woodAxe, 1, secToMs(1.5, 0.75, 0.4, 0.25, 0.2, 0.15));
setBlock(Material.WALL_SIGN, pumpkinType);
setBlock(BridgeMaterial.SIGN, pumpkinType);
setBlock(Material.PUMPKIN, pumpkinType);
setBlock(Material.JACK_O_LANTERN, pumpkinType);
setBlock(BridgeMaterial.MELON, new BlockProps(noTool, 1, secToMs(1.45), 3));
setBlock(Material.BOOKSHELF, new BlockProps(woodAxe, 1.5f, secToMs(2.25, 1.15, 0.6, 0.4, 0.3, 0.2)));
for (Material mat : new Material[]{
Material.JUKEBOX,
BridgeMaterial.get("wood_double_step"),
// double slabs ?
}) {
if (mat != null) {
setBlock(mat, woodType);
}
}
@SuppressWarnings("unchecked")
final List<Set<Material>> woodTypes = Arrays.asList(
MaterialUtil.WOODEN_FENCE_GATES, MaterialUtil.WOODEN_FENCES,
MaterialUtil.WOODEN_STAIRS, MaterialUtil.WOODEN_SLABS,
MaterialUtil.LOGS, MaterialUtil.WOOD_BLOCKS,
MaterialUtil.PLANKS
);
for (final Set<Material> set : woodTypes) {
for (final Material mat : set) {
setBlock(mat, woodType);
}
}
for (Material mat : new Material[] {
Material.CAULDRON,
Material.COBBLESTONE_STAIRS, Material.COBBLESTONE,
BridgeMaterial.NETHER_BRICKS, Material.NETHER_BRICK_STAIRS,
BridgeMaterial.NETHER_BRICK_FENCE,
Material.MOSSY_COBBLESTONE,
BridgeMaterial.BRICKS, Material.BRICK_STAIRS,
Material.BRICK_STAIRS, BridgeMaterial.BRICK_SLAB,
BridgeMaterial.STONE_SLAB,
BridgeMaterial.get("double_step"), // ?
}) {
if (mat != null) {
setBlock(mat, brickType);
}
}
setBlock(BridgeMaterial.CRAFTING_TABLE, chestType);
setBlock(Material.CHEST, chestType);
for (Material mat : MaterialUtil.WOODEN_DOORS) {
setBlock(mat, woodDoorType);
}
for (Material mat : MaterialUtil.WOODEN_TRAP_DOORS) {
setBlock(mat, woodDoorType);
}
for (Material mat : new Material[]{
BridgeMaterial.END_STONE, Material.COAL_ORE,
}) {
setBlock(mat, coalType);
}
setBlock(Material.DRAGON_EGG, new BlockProps(noTool, 3f, secToMs(4.5))); // Former: coalType.
final long[] ironTimes = secToMs(15, 15, 1.15, 0.75, 0.6, 15);
final BlockProps ironType = new BlockProps(stonePickaxe, 3, ironTimes);
for (Material mat : new Material[]{
Material.LAPIS_ORE, Material.LAPIS_BLOCK, Material.IRON_ORE,
}) {
setBlock(mat, ironType);
}
final long[] diamondTimes = secToMs(15, 15, 15, 0.75, 0.6, 15);
final BlockProps diamondType = new BlockProps(ironPickaxe, 3, diamondTimes);
for (Material mat : new Material[]{
Material.REDSTONE_ORE, BridgeMaterial.get("glowing_redstone_ore"),
Material.EMERALD_ORE, Material.GOLD_ORE, Material.DIAMOND_ORE,
}) {
if (mat != null) {
setBlock(mat, diamondType);
}
}
setBlock(Material.GOLD_BLOCK, goldBlockType);
setBlock(Material.FURNACE, dispenserType);
if (BridgeMaterial.has("burning_furnace")) {
setBlock(BridgeMaterial.get("burning_furnace"), dispenserType);
}
setBlock(Material.DISPENSER, dispenserType);
setBlock(BridgeMaterial.COBWEB, new BlockProps(woodSword, 4, secToMs(20, 0.4, 0.4, 0.4, 0.4, 0.4)));
for (Material mat : new Material[]{
BridgeMaterial.SPAWNER, BridgeMaterial.IRON_DOOR,
BridgeMaterial.IRON_BARS, BridgeMaterial.ENCHANTING_TABLE,
Material.EMERALD_BLOCK,
}) {
setBlock(mat, ironDoorType);
}
setBlock(Material.IRON_BLOCK, ironBlockType);
setBreakingTimeOverridesByEfficiency(new BlockBreakKey().blockType(Material.IRON_BLOCK)
.toolType(ToolType.PICKAXE).materialBase(MaterialBase.WOOD),
ironBlockType.breakingTimes[1], 6200L, 3500L, 2050L, 1350L, 900L);
setBlock(Material.DIAMOND_BLOCK, diamondBlockType);
setBlock(Material.ENDER_CHEST, new BlockProps(woodPickaxe, 22.5f));
setBlock(Material.OBSIDIAN, new BlockProps(diamondPickaxe, 50, secToMs(250, 125, 62.5, 41.6, 9.4, 20.8)));
// More 1.4 (not insta).
// TODO: Either move all to an extra setup class, or integrate above.
setBlock(Material.BEACON, new BlockProps(noTool, 25f, secToMs(4.45))); // TODO
setBlock(BridgeMaterial.COBBLESTONE_WALL, brickType);
setFlag(BridgeMaterial.COBBLESTONE_WALL, F_HEIGHT150);
for (Material mat : MaterialUtil.WOODEN_BUTTONS) {
setBlock(mat, leverType);
}
props = new BlockProps(noTool, 8.5f, secToMs(1.45));
for (Material mat : MaterialUtil.HEADS_GROUND) {
setBlock(mat, props);
setFlag(mat, F_SOLID | F_GROUND);
}
setBlock(Material.ANVIL, new BlockProps(woodPickaxe, 5f)); // TODO
for (final Material mat : MaterialUtil.FLOWER_POTS) {
BlockFlags.addFlags(mat, F_SOLID | F_GROUND);
setBlockProps(mat, instantType);
}
// Indestructible.
for (Material mat : new Material[]{
Material.AIR, BridgeMaterial.END_PORTAL, BridgeMaterial.END_PORTAL_FRAME,
BridgeMaterial.NETHER_PORTAL, Material.BEDROCK,
BridgeMaterial.get("void_air")
}) {
if (mat != null) {
setBlock(mat, indestructibleType);
}
}
@SuppressWarnings("unchecked")
final List<Set<Material>> indestructible = new LinkedList<Set<Material>>(Arrays.asList(
MaterialUtil.LAVA,
MaterialUtil.WATER
));
for (Set<Material> set : indestructible) {
for (Material mat : set) {
setBlock(mat, indestructibleType);
}
}
// 95 Locked chest
// blocks[95] = indestructibleType; // Locked chest (prevent crash with 1.7).
if (BridgeMaterial.has("locked_chest")) {
BlockFlags.setFlagsAs("locked_chest", Material.CHEST);
// Breaks like chest later on.
setBlockProps("locked_chest", BlockProperties.instantType);
}
// Terracotta (hard_clay).
props = new BlockProps(BlockProperties.woodPickaxe, 1.25f,
BlockProperties.secToMs(6.25, 0.95, 0.5, 0.35, 0.25, 0.2));
for (final Material mat : MaterialUtil.TERRACOTTA_BLOCKS) {
BlockProperties.setBlockProps(mat, props);
BlockFlags.setFlagsAs(mat, Material.STONE);
}
// Glazed Terracotta
props = new BlockProps(BlockProperties.woodPickaxe, 1.4f,
BlockProperties.secToMs(7.0, 1.05, 0.55, 0.35, 0.3, 0.2));
for (final Material mat : MaterialUtil.GLAZED_TERRACOTTA_BLOCKS) {
BlockProperties.setBlockProps(mat, props);
BlockFlags.setFlagsAs(mat, BridgeMaterial.TERRACOTTA);
}
// Carpets.
final BlockProps carpetProps = new BlockProps(BlockProperties.noTool, 0.1f,
BlockProperties.secToMs(0.15));
final long carpetFlags = BlockProperties.F_GROUND | BlockProperties.F_IGN_PASSABLE
| BlockProperties.F_GROUND_HEIGHT | BlockProperties.F_CARPET;
for (final Material mat : MaterialUtil.CARPETS) {
BlockProperties.setBlockProps(mat, carpetProps);
setBlockFlags(mat, carpetFlags);
}
// Banners.
props = new BlockProps(BlockProperties.woodAxe, 0.4f, BlockProperties.secToMs(1.5, 0.75, 0.4, 0.25, 0.2, 0.15));
for (Material mat : MaterialUtil.BANNERS) {
BlockProperties.setBlockFlags(mat, 0L);
setBlockProps(mat, props);
}
// Wall banners.
for (Material mat : MaterialUtil.WALL_BANNERS) {
BlockInit.setInstantAir(mat);
}
// Shulker boxes
for (Material mat : MaterialUtil.SHULKER_BOXES) {
// Wiki (16-11-25): 9, 4.5, 2.25, 1.5, 1.15, 0.75
BlockProperties.setBlockProps(mat, new BlockProps(BlockProperties.woodPickaxe, 6,
BlockProperties.secToMs(10.0, 1.45, 0.7, 0.5, 0.35, 0.2)));
BlockProperties.setBlockFlags(mat, BlockProperties.F_SOLID | BlockProperties.F_GROUND);
}
// Concrete
props = new BlockProps(BlockProperties.woodPickaxe, 1.8f,
// TODO: 2.7 with bare hands seems unlikely.
BlockProperties.secToMs(2.7, 1.35, 0.7, 0.45, 0.35, 0.25));
for (Material mat : MaterialUtil.CONCRETE_BLOCKS) {
setBlockProps(mat, props);
BlockFlags.setFlagsAs(mat, Material.COBBLESTONE);
}
// Concrete powder
for (Material mat : MaterialUtil.CONCRETE_POWDER_BLOCKS) {
BlockInit.setAs(mat, Material.DIRT);
}
// Stripped logs.
for (Material mat : MaterialUtil.STRIPPED_LOGS) {
BlockInit.setAs(mat, BridgeMaterial.OAK_LOG);
}
// Stripped wood blocks.
for (Material mat : MaterialUtil.STRIPPED_WOOD_BLOCKS) {
BlockInit.setAs(mat, BridgeMaterial.OAK_WOOD);
}
// Wool blocks.
props = new BlockProps(tools.get(Material.SHEARS), 0.8f,
secToMs(1.25, 1.25, 1.25, 1.25, 1.25, 1.25));
for (Material mat : MaterialUtil.WOOL_BLOCKS) {
BlockFlags.setFlagsAs(mat, Material.STONE);
setBlockProps(mat, props);
// TODO: Model shears directly somehow (per-block list).
}
// Fully solid blocks (shape / passable) - simplifies MCAccessBukkit setup, aim at 1.13+.
for (Material mat : MaterialUtil.FULLY_SOLID_BLOCKS) {
BlockFlags.addFlags(mat,
// Full bounds for sure.
BlockFlags.FULL_BOUNDS
/*
* Ensure solid is set (slight abuse/ambiguity
* with ground, and potential future use of
* Material#isSolid.
*/
| BlockProperties.F_SOLID);
}
}
/**
* Set breaking time overrides for specific side conditions. Starting at
* efficiency 0, the breaking time is fetched from the given times array,
* with efficiency level being the index, always starting at 0.
*
* @param baseKey
* @param times
*/
public static void setBreakingTimeOverridesByEfficiency(final BlockBreakKey baseKey,
final long... times) {
for (int i = 0; i < times.length; i++) {
setBreakingTimeOverride(new BlockBreakKey(baseKey).efficiency(i), times[i]);
}
}
/**
* Dump blocks.
*
* @param all
* the all
*/
public static void dumpBlocks(boolean all) {
// Dump name-based setup.
//StaticLog.logDebug("All non-legacy Material found: " + StringUtil.join(BridgeMaterial.getKeySet(), ", "));
//StaticLog.logDebug("Dump Material collections:");
//MaterialUtil.dumpStaticSets(MaterialUtil.class, Level.FINE);
// Check for initialized block breaking data.
/*
* TODO: Possibly switch to a class per block, to see what/if-anything
* is initialized, including flags.
*/
final LogManager logManager = NCPAPIProvider.getNoCheatPlusAPI().getLogManager();
List<String> missing = new LinkedList<String>();
List<String> allBlocks = new LinkedList<String>();
if (all) {
allBlocks.add("Dump block properties:");
allBlocks.add("--- Present entries -------------------------------");
}
List<String> tags = new ArrayList<String>();
for (Material temp : Material.values()) {
String mat;
try{
if (!temp.isBlock()) {
continue;
}
mat = temp.toString();
}
catch(Exception e) {
mat = "?";
}
tags.clear();
addFlagNames(getBlockFlags(temp), tags);
String tagsJoined = tags.isEmpty() ? "" : " / " + StringUtil.join(tags, "+");
if (blocks.get(temp) == null) {
if (mat.equals("?")) {
continue;
}
missing.add("* BLOCK BREAKING (" + mat + tagsJoined + ") ");
}
else {
if (getBlockFlags(temp) == 0L && !isAir(temp)) {
missing.add("* FLAGS (" + mat + tagsJoined + ") " + getBlockProps(temp).toString());
}
if (all) {
allBlocks.add(": (" + mat + tagsJoined + ") " + getBlockProps(temp).toString());
}
}
}
if (all) {
logManager.info(Streams.DEFAULT_FILE, StringUtil.join(allBlocks, "\n"));
}
if (!missing.isEmpty()) {
missing.add(0, "--- Missing entries -------------------------------");
missing.add(0, "The block breaking data is incomplete, default to allow instant breaking:");
logManager.warning(Streams.INIT, StringUtil.join(missing, "\n"));
}
}
/**
* Add all flag names for existing default flags to the list.
*
* @param flags
* the flags
* @param tags
* Flag names will be added to this list (not with the
* "F_"-prefix).
*/
public static void addFlagNames(final long flags, final Collection<String> tags) {
String tag = flagNameMap.get(flags);
if (tag != null) {
tags.add(tag);
return;
}
for (final Long flag : flagNameMap.keySet()) {
if ((flags & flag) != 0) {
tags.add(flagNameMap.get(flag));
}
}
}
/**
* Return a collection containing all names of the flags.
*
* @param flags
* the flags
* @return the flag names
*/
public static Collection<String> getFlagNames(final Long flags) {
final ArrayList<String> tags = new ArrayList<String>(flagNameMap.size());
if (flags == null) {
return tags;
}
addFlagNames(flags, tags);
return tags;
}
/**
* Get all flag names. Results don't start with the 'F_' prefix.
*
* @return
*/
public static Collection<String> getAllFlagNames() {
final Set<String> res = new LinkedHashSet<String>();
for (final String name : nameFlagMap.keySet()) {
if (!name.startsWith("F_")) {
res.add(name);
}
}
return res;
}
/**
* Convenience method to parse a flag.
*
* @param input
* the input
* @return the long
* @throws InputMismatchException
* if failed to parse.
*/
public static long parseFlag(final String input) {
final String ucInput = input.trim().toUpperCase();
final Long flag = nameFlagMap.get(ucInput);
if (flag != null) {
return flag.longValue();
}
try{
final Long altFlag = Long.parseLong(input);
return altFlag;
} catch (NumberFormatException e) {}
// TODO: This very exception type?
throw new InputMismatchException();
}
/**
* Sec to ms.
*
* @param s1
* the s1
* @param s2
* the s2
* @param s3
* the s3
* @param s4
* the s4
* @param s5
* the s5
* @param s6
* the s6
* @return the long[]
*/
public static long[] secToMs(final double s1, final double s2, final double s3,
final double s4, final double s5, final double s6) {
return new long[] { (long) (s1 * 1000d), (long) (s2 * 1000d), (long) (s3 * 1000d), (long) (s4 * 1000d), (long) (s5 * 1000d), (long) (s6 * 1000d) };
}
/**
* Sec to ms.
*
* @param s1
* the s1
* @return the long[]
*/
public static long[] secToMs(final double s1) {
final long v = (long) (s1 * 1000d);
return new long[]{v, v, v, v, v, v};
}
/**
* Gets the tool props.
*
* @param stack
* the stack
* @return the tool props
*/
public static ToolProps getToolProps(final ItemStack stack) {
if (stack == null) {
return noTool;
}
else {
return getToolProps(stack.getType());
}
}
/**
* Gets the tool props.
*
* @param mat
* the mat
* @return the tool props
*/
public static ToolProps getToolProps(final Material mat) {
final ToolProps props = tools.get(mat);
if (props == null) {
return noTool;
}
else {
return props;
}
}
/**
* Gets the block props.
*
* @param stack
* the stack
* @return the block props
*/
public static BlockProps getBlockProps(final ItemStack stack) {
if (stack == null) {
return defaultBlockProps;
}
else {
return getBlockProps(stack.getType());
}
}
/**
* Gets the block props.
*
* @param mat
* the mat
* @return the block props
*/
public static BlockProps getBlockProps(final Material mat) {
if (mat == null || !blocks.containsKey(mat)) {
return defaultBlockProps;
}
else {
return blocks.get(mat);
}
}
/**
* Gets the block props.
*
* @param blockId
* the block id
* @return the block props
*/
public static BlockProps getBlockProps(final String blockId) {
return getBlockProps(BlockProperties.getMaterial(blockId));
}
/**
* Set a breaking time override for specific side conditions. Copies the key
* for internal storage.
*
* @param key
* @param breakingTime
* The breaking time in milliseconds.
*/
public static void setBreakingTimeOverride(final BlockBreakKey key, long breakingTime) {
breakingTimeOverrides.put(new BlockBreakKey(key), breakingTime);
}
/**
* Get a breaking time override for specific side conditions.
*
* @param key
* @return The breaking time in milliseconds or null, if not set.
*/
public static Long getBreakingTimeOverride(final BlockBreakKey key) {
return breakingTimeOverrides.get(key);
}
/**
* Convenience method.
*
* @param BlockType
* the block type
* @param player
* the player
* @return the breaking duration
*/
public static long getBreakingDuration(final Material BlockType, final Player player) {
final long res = getBreakingDuration(BlockType,
Bridge1_9.getItemInMainHand(player), player.getInventory().getHelmet(),
player, player.getLocation(useLoc));
useLoc.setWorld(null);
return res;
}
/**
* Convenience method.
*
* @param blockId
* @param itemInHand
* May be null.
* @param helmet
* May be null.
* @param player
* @param location
* @return
*/
public static long getBreakingDuration(final Material blockId, final ItemStack itemInHand, final ItemStack helmet,
final Player player, final Location location) {
return getBreakingDuration(blockId, itemInHand, helmet, player, MovingUtil.getEyeHeight(player), location);
}
/**
* Convenience method.
* @param blockId
* @param itemInHand
* @param helmet
* @param player
* @param eyeHEight
* @param location
* @return
*/
public static long getBreakingDuration(final Material blockId, final ItemStack itemInHand, final ItemStack helmet,
final Player player, final double eyeHeight, final Location location) {
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, 0.3);
// On ground.
final boolean onGround = pLoc.isOnGround();
// Head in water.
final int bx = pLoc.getBlockX();
final int bz = pLoc.getBlockZ();
final double y = pLoc.getY() + eyeHeight;
final int by = Location.locToBlock(y);
final Material headId = blockCache.getType(bx, by, bz);
final long headFlags = getBlockFlags(headId);
final boolean inWater;
if ((headFlags & F_WATER) == 0) {
inWater = false;
}
else {
// Check real bounding box collision.
// (Not sure which to use here.)
final int data8 = (blockCache.getData(bx, by, bz) & 0xF) % 8;
final double level;
if ((data8 & 8) != 0) {
level = 1.0;
}
else {
level = 1.0 - 0.125 * (1.0 + data8);
}
inWater = y - by < level; // <= ? ...
}
blockCache.cleanup();
pLoc.cleanup();
// Haste (faster digging).
final double haste = PotionUtil.getPotionEffectAmplifier(player, PotionEffectType.FAST_DIGGING);
// TODO: haste: int / double !?
return getBreakingDuration(blockId, itemInHand, onGround, inWater, helmet != null && helmet.containsEnchantment(Enchantment.WATER_WORKER), Double.isInfinite(haste) ? 0 : 1 + (int) haste);
}
/**
* Get the normal breaking duration, including enchantments, and tool
* properties.
*
* @param blockId
* the block id
* @param itemInHand
* the item in hand
* @param onGround
* the on ground
* @param inWater
* the in water
* @param aquaAffinity
* the aqua affinity
* @param haste
* the haste
* @return the breaking duration
*/
public static long getBreakingDuration(final Material blockId, final ItemStack itemInHand,
final boolean onGround, final boolean inWater, final boolean aquaAffinity, final int haste) {
// TODO: more configurability / load from file for blocks (i.e. set for shears etc.
if (isAir(itemInHand)) {
return getBreakingDuration(blockId, getBlockProps(blockId), noTool,
onGround, inWater, aquaAffinity, 0, 0); // Nor efficiency nor haste do apply.
}
else {
int efficiency = 0;
if (itemInHand.containsEnchantment(Enchantment.DIG_SPEED)) {
efficiency = itemInHand.getEnchantmentLevel(Enchantment.DIG_SPEED);
}
return getBreakingDuration(blockId,
getBlockProps(blockId), getToolProps(itemInHand.getType()),
onGround, inWater, aquaAffinity, efficiency, haste);
}
}
/**
*
* @param blockId
* @param blockProps
* @param toolProps
* @param onGround
* @param inWater
* @param aquaAffinity
* @param efficiency
* @return
* @deprecated Public method not containing haste.
*/
public static long getBreakingDuration(final Material blockId,
final BlockProps blockProps, final ToolProps toolProps,
final boolean onGround, final boolean inWater, boolean aquaAffinity,
int efficiency) {
return getBreakingDuration(blockId, blockProps, toolProps,
onGround, inWater, aquaAffinity, efficiency, 0);
}
/**
* Gets the breaking duration.
*
* @param blockId
* the block id
* @param blockProps
* the block props
* @param toolProps
* the tool props
* @param onGround
* the on ground
* @param inWater
* the in water
* @param aquaAffinity
* the aqua affinity
* @param efficiency
* the efficiency
* @param haste
* Amplifier of haste potion effect (assume > 0 for effect there
* at all, so 1 is haste I, 2 is haste II).
* @return the breaking duration
*/
public static long getBreakingDuration(final Material blockId,
final BlockProps blockProps, final ToolProps toolProps,
final boolean onGround, final boolean inWater, boolean aquaAffinity,
int efficiency, int haste) {
final long dur = getBreakingDurationNoHaste(blockId, blockProps, toolProps, onGround, inWater, aquaAffinity, efficiency);
return haste > 0 ? (long) (Math.pow(0.8, haste) * dur) : dur;
}
/**
* Breaking duration without haste applied.
*
* @param blockId
* @param blockProps
* @param toolProps
* @param onGround
* @param inWater
* @param aquaAffinity
* @param efficiency
* @return
*/
private static long getBreakingDurationNoHaste(final Material blockId,
final BlockProps blockProps, final ToolProps toolProps,
final boolean onGround, final boolean inWater, boolean aquaAffinity,
int efficiency) {
// First check for direct breaking time overrides.
final BlockBreakKey bbKey = new BlockBreakKey();
// Add the basic properties.
bbKey.blockType(blockId)
.toolType(toolProps.toolType)
.materialBase(toolProps.materialBase)
.efficiency(efficiency) // TODO: Might leave this out and calculate based on the already fetched.
;
Long override = breakingTimeOverrides.get(bbKey);
if (override != null) {
float mult = getBlockBreakingPenaltyMultiplier(onGround, inWater, aquaAffinity);
return mult == 1.0f ? override : (long) (mult * override);
}
// TODO: Keep up to date with BlockBreakKey, allow inWater and haste to not be set (calculate).
// Classic calculation.
boolean isValidTool = isValidTool(blockId, blockProps, toolProps, efficiency);
if (efficiency > 0) {
// Workaround until something better is found..
// TODO: Re-evaluate.
if (isLeaves(blockId) || blockProps == glassType) {
if (efficiency == 1) {
return 100;
}
else {
return 0; // insta break.
}
}
else if (blockProps == chestType) {
// TODO: The no tool time might be reference anyway for some block types.
return (long) ((double )blockProps.breakingTimes[0] / 5f / efficiency);
}
}
long duration;
if (isValidTool) {
// appropriate tool
duration = blockProps.breakingTimes[toolProps.materialBase.index];
if (efficiency > 0) {
duration = (long) (duration / blockProps.efficiencyMod);
}
}
else {
// Inappropriate tool.
duration = blockProps.breakingTimes[0];
// Swords are always appropriate.
if (toolProps.toolType == ToolType.SWORD) {
duration = (long) ((float) duration / 1.5f);
}
}
// Specialties:
if (toolProps.toolType == ToolType.SHEARS) {
// (Note: shears are not in the block props, anywhere)
// Treat these extra (partly experimental):
if (blockId == BridgeMaterial.COBWEB) {
duration = 400;
isValidTool = true;
}
else if (MaterialUtil.WOOL_BLOCKS.contains(blockId)) {
duration = 240;
isValidTool = true;
}
else if (isLeaves(blockId)) {
duration = 20;
isValidTool = true;
}
else if (blockId == Material.VINE) {
duration = 300;
isValidTool = true;
}
}
// (sword vs web already counted)
else if (blockId == Material.VINE && toolProps.toolType == ToolType.AXE) {
isValidTool = true;
if (toolProps.materialBase == MaterialBase.WOOD || toolProps.materialBase == MaterialBase.STONE) {
duration = 100;
}
else {
duration = 0;
}
}
if (isValidTool || blockProps.tool.toolType == ToolType.NONE) {
float mult = getBlockBreakingPenaltyMultiplier(onGround, inWater, aquaAffinity);
if (mult != 1f) {
duration *= mult;
}
// Efficiency level.
if (efficiency > 0) {
// Workarounds ...
if (toolProps.toolType != ToolType.AXE
&& MaterialUtil.WOODEN_DOORS.contains(blockId)) {
// Heck [Cleanup pending]...
switch (efficiency) {
case 1:
return (long) (mult * 1500);
case 2:
return (long) (mult * 750);
case 3:
return (long) (mult * 450);
case 4:
return (long) (mult * 250);
case 5:
return (long) (mult * 150);
}
}
// This seems roughly correct.
for (int i = 0; i < efficiency; i++) {
duration /= 1.33; // Matches well with obsidian.
}
// Formula from MC wiki.
// TODO: Formula from mc wiki does not match well (too fast for obsidian).
// duration /= (1.0 + 0.5 * efficiency);
// More Workarounds:
// TODO: Consider checking a generic workaround (based on duration, assuming some dig packets lost, proportional to duration etc.).
if (toolProps.materialBase == MaterialBase.WOOD) {
if (toolProps.toolType == ToolType.PICKAXE && (blockProps == ironDoorType || blockProps == dispenserType)) {
// Special correction.
// TODO: Uncomfortable: hide this in the blocks by some flags / other type of workarounds !
if (blockProps == dispenserType) {
duration = (long) (duration / 1.5 - (efficiency - 1) * 60);
}
else if (blockProps == ironDoorType) {
duration = (long) (duration / 1.5 - (efficiency - 1) * 100);
}
}
else if (MaterialUtil.isLog(blockId)) {
duration -= efficiency >= 4 ? 250 : 400;
}
else if (blockProps.tool.toolType == toolProps.toolType) {
duration -= 250;
}
else {
duration -= efficiency * 30;
}
}
else if (toolProps.materialBase == MaterialBase.STONE) {
if (MaterialUtil.isLog(blockId)) {
duration -= 100;
}
}
}
}
// Post/legacy workarounds for efficiency tools ("improper").
if (efficiency > 0 && !isValidTool) {
if (!isValidTool && blockId == BridgeMaterial.MELON) {
// Fall back to pre-1.8 behavior.
// 450, 200 , 100 , 50 , 0
duration = Math.min(duration, 450 / (long) Math.pow(2, efficiency - 1));
}
}
return Math.max(0, duration);
}
private static float getBlockBreakingPenaltyMultiplier(
final boolean onGround, final boolean inWater, final boolean aquaAffinity) {
float mult = 1f;
if (inWater && !aquaAffinity) {
mult *= breakPenaltyInWater;
}
if (!onGround) {
mult *= breakPenaltyOffGround;
}
return mult;
}
/**
* Check if the tool is officially appropriate for the block id, counting in
* efficiency enchantments.
*
* @param blockId
* the block id
* @param blockProps
* the block props
* @param toolProps
* the tool props
* @param efficiency
* the efficiency
* @return true, if is valid tool
*/
public static boolean isValidTool(final Material blockId, final BlockProps blockProps,
final ToolProps toolProps, final int efficiency) {
boolean isValidTool = blockProps.tool.toolType == toolProps.toolType;
if (!isValidTool && efficiency > 0) {
// Efficiency makes the tool.
// (wood, sand, gravel, ice)
if (blockId == Material.SNOW) {
return toolProps.toolType == ToolType.SPADE;
}
if (MaterialUtil.WOOL_BLOCKS.contains(blockId)) {
return true;
}
if (MaterialUtil.WOODEN_DOORS.contains(blockId)) {
return true;
}
if (blockProps.hardness <= 2
&& (blockProps.tool.toolType == ToolType.AXE
|| blockProps.tool.toolType == ToolType.SPADE
|| (blockProps.hardness < 0.8
&& (blockId != Material.NETHERRACK
&& blockId != Material.SNOW
&& blockId != Material.SNOW_BLOCK
&& blockId != BridgeMaterial.STONE_PRESSURE_PLATE)))) {
// Also roughly.
return true;
}
}
return isValidTool;
}
/**
* Access API for setting tool properties.<br>
* NOTE: No guarantee that this harmonizes with internals and workarounds,
* currently.
*
* @param itemId
* the item id
* @param toolProps
* the tool props
*/
public static void setToolProps(Material itemId, ToolProps toolProps) {
if (toolProps == null) {
throw new NullPointerException("ToolProps must not be null");
}
toolProps.validate();
// No range check.
tools.put(itemId, toolProps);
}
/**
* Access API to set a blocks properties. NOTE: No guarantee that this
* harmonizes with internals and workarounds, currently.
*
* @param blockId
* the block id
* @param blockProps
* the block props
*/
public static void setBlockProps(String blockId, BlockProps blockProps) {
setBlockProps(BlockProperties.getMaterial(blockId), blockProps);
}
/**
* Access API to set a blocks properties. NOTE: No guarantee that this
* harmonizes with internals and workarounds, currently.
*
* @param blockId
* the block id
* @param blockProps
* the block props
*/
public static void setBlockProps(Material blockId, BlockProps blockProps) {
if (blockProps == null) {
throw new NullPointerException("BlockProps must not be null");
}
blockProps.validate();
setBlock(blockId, blockProps);
}
/**
* Checks if is valid tool.
*
* @param blockType
* the block type
* @param itemInHand
* the item in hand
* @return true, if is valid tool
*/
public static boolean isValidTool(final Material blockType, final ItemStack itemInHand) {
final BlockProps blockProps = getBlockProps(blockType);
final ToolProps toolProps = getToolProps(itemInHand);
final int efficiency = itemInHand == null ? 0 : itemInHand.getEnchantmentLevel(Enchantment.DIG_SPEED);
return isValidTool(blockType, blockProps, toolProps, efficiency);
}
/**
* Gets the default block props.
*
* @return the default block props
*/
public static BlockProps getDefaultBlockProps() {
return defaultBlockProps;
}
/**
* Feeding null will cause an npe - will validate.
*
* @param blockProps
* the new default block props
*/
public static void setDefaultBlockProps(BlockProps blockProps) {
blockProps.validate();
BlockProperties.defaultBlockProps = blockProps;
}
/**
* Simple checking method, heavy. No isIllegal check.
*
* @param player
* the player
* @param location
* the location
* @param yOnGround
* the y on ground
* @return true, if is in liquid
*/
public static boolean isInLiquid(final Player player, final Location location, final double yOnGround) {
// Bit fat workaround, maybe put the object through from check listener ?
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, yOnGround);
final boolean res = pLoc.isInLiquid();
blockCache.cleanup();
pLoc.cleanup();
return res;
}
/**
* Simple checking method, heavy. No isIllegal check.
*
* @param player
* the player
* @param location
* the location
* @param yOnGround
* the y on ground
* @return true, if is in web
*/
public static boolean isInWeb(final Player player, final Location location, final double yOnGround) {
// Bit fat workaround, maybe put the object through from check listener ?
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, yOnGround);
final boolean res = pLoc.isInWeb();
blockCache.cleanup();
pLoc.cleanup();
return res;
}
/**
* Simple checking method, heavy. No isIllegal check.
*
* @param player
* the player
* @param location
* the location
* @param yOnGround
* the y on ground
* @return true, if is on ground
*/
public static boolean isOnGround(final Player player, final Location location, final double yOnGround) {
// Bit fat workaround, maybe put the object through from check listener ?
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, yOnGround);
final boolean res = pLoc.isOnGround();
blockCache.cleanup();
pLoc.cleanup();
return res;
}
/**
* Simple checking method, heavy. No isIllegal check.
*
* @param player
* the player
* @param location
* the location
* @param yOnGround
* the y on ground
* @return true, if is on ground or reset cond
*/
public static boolean isOnGroundOrResetCond(final Player player, final Location location,
final double yOnGround) {
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, yOnGround);
final boolean res = pLoc.isOnGroundOrResetCond();
blockCache.cleanup();
pLoc.cleanup();
return res;
}
/**
* Simple checking method, heavy. No isIllegal check.
*
* @param player
* the player
* @param location
* the location
* @param yOnGround
* the y on ground
* @return true, if is reset cond
*/
public static boolean isResetCond(final Player player, final Location location, final double yOnGround) {
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(location.getWorld());
pLoc.setBlockCache(blockCache);
pLoc.set(location, player, yOnGround);
final boolean res = pLoc.isResetCond();
blockCache.cleanup();
pLoc.cleanup();
return res;
}
/**
* Get the (legacy) data value for the block.
*
* @param block
* the block
* @return the data
*/
public static int getData(final Block block) {
return block.getData();
}
/**
* Straw-man method to hide warnings.
*
* @param id
* the id
* @return the material
*/
public static Material getMaterial(final String id) {
return Material.valueOf(id);
}
/**
* Gets the block flags.
*
* @param blockType
* the block type
* @return the block flags
*/
public static final long getBlockFlags(final Material blockType) {
return blockFlags.containsKey(blockType) ? blockFlags.get(blockType) : 0;
}
/**
* Gets the block flags.
*
* @param id
* the id
* @return the block flags
*/
public static final long getBlockFlags(final String id) {
return getBlockFlags(BlockProperties.getMaterial(id));
}
/**
* Sets the block flags.
*
* @param blockType
* the block type
* @param flags
* the flags
*/
public static final void setBlockFlags(final Material blockType, final long flags) {
if (!blockType.isBlock()) {
// Let's not fail hard here.
StaticLog.logWarning("Attempt to set flags for a non-block: " + blockType);
}
blockFlags.put(blockType, flags);
}
/**
* Sets the block flags.
*
* @param id
* the id
* @param flags
* the flags
*/
public static final void setBlockFlags(final String id, final long flags) {
setBlockFlags(BlockProperties.getMaterial(id), flags);
}
/**
* Auxiliary check for if this block is climbable and allows climbing up.
* Does not account for jumping off ground etc.
*
* @param cache
* the cache
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @return true, if successful
*/
public static final boolean canClimbUp(final BlockCache cache, final int x, final int y, final int z) {
final Material id = cache.getType(x, y, z);
if ((getBlockFlags(id) & F_CLIMBABLE) == 0) {
return false;
}
if (id == Material.LADDER) {
return true;
}
// The direct way is a problem (backwards compatibility to before 1.4.5-R1.0).
if ((getBlockFlags(cache.getType(x + 1, y, z)) & F_SOLID) != 0) {
return true;
}
if ((getBlockFlags(cache.getType(x - 1, y, z)) & F_SOLID) != 0) {
return true;
}
if ((getBlockFlags(cache.getType(x, y, z + 1)) & F_SOLID) != 0) {
return true;
}
if ((getBlockFlags(cache.getType(x, y, z - 1)) & F_SOLID) != 0) {
return true;
}
return false;
}
/**
* Checks if is climbable.
*
* @param id
* the id
* @return true, if is climbable
*/
public static final boolean isClimbable(final Material id) {
return (getBlockFlags(id) & F_CLIMBABLE) != 0;
}
/**
* Climbable material that needs to be attached to a block, to allow players
* to climb up.<br>
* Currently only applies to vines. There is no flag for such, yet.
*
* @param id
* the id
* @return true, if is attached climbable
*/
public static final boolean isAttachedClimbable(final Material id) {
return id == Material.VINE;
}
/**
* Checks if is stairs.
*
* @param id
* the id
* @return true, if is stairs
*/
public static final boolean isStairs(final Material id) {
return (getBlockFlags(id) & F_STAIRS) != 0;
}
/**
* Checks if is liquid.
*
* @param blockType
* the block type
* @return true, if is liquid
*/
public static final boolean isLiquid(final Material blockType) {
return (getBlockFlags(blockType) & F_LIQUID) != 0;
}
/**
* Test for water type of blocks.
*
* @param blockType
* @return
*/
public static final boolean isWater(final Material blockType) {
return (getBlockFlags(blockType) & F_WATER) != 0;
}
/**
* Checks if is ice.
*
* @param id
* the id
* @return true, if is ice
*/
public static final boolean isIce(final Material id) {
return (getBlockFlags(id) & F_ICE) != 0;
}
/**
* Checks if is leaves.
*
* @param id
* the id
* @return true, if is leaves
*/
public static final boolean isLeaves(final Material id) {
return (getBlockFlags(id) & F_LEAVES) != 0;
}
/**
* Checks if is carpet.
*
* @param id
* the id
* @return true, if is carpet
*/
public static final boolean isCarpet(final Material id) {
return (getBlockFlags(id) & F_CARPET) != 0;
}
/**
* Might hold true for liquids too.
*
* @param blockType
* the block type
* @return true, if is solid
*/
public static final boolean isSolid(final Material blockType) {
return (getBlockFlags(blockType) & F_SOLID) != 0;
}
/**
* Might hold true for liquids too. TODO: ENSURE IT DOESN'T.
*
* @param blockType
* the block type
* @return true, if is ground
*/
public static final boolean isGround(final Material blockType) {
return (getBlockFlags(blockType) & F_GROUND) != 0;
}
/**
* Might hold true for liquids too. TODO: ENSURE IT DOESN'T.
*
* @param id
* the id
* @return true, if is ground
*/
public static final boolean isGround(final Material id, final long ignoreFlags) {
final long flags = getBlockFlags(id);
return (flags & F_GROUND) != 0 && (flags & ignoreFlags) == 0;
}
/**
* Convenience method including null checks.
*
* @param type
* the type
* @return true, if is air
*/
public static final boolean isAir(Material type) {
// TODO: Flags rather?
return type == null || type == Material.AIR
// Assume the compiler throws away further null values.
|| type == BridgeMaterial.VOID_AIR
|| type == BridgeMaterial.CAVE_AIR
;
}
/**
* Convenience method including null checks.
*
* @param stack
* the stack
* @return true, if is air
*/
public static final boolean isAir(ItemStack stack) {
return stack == null || isAir(stack.getType());
}
/**
* Get the facing direction as BlockFace, unified approach with attached to
* = opposite of facing. Likely the necessary flags are just set where it's
* been needed so far.
*
* @param flags
* the flags
* @param data
* the data
* @return Return null, if facing can not be determined.
*/
public static final BlockFace getFacing(final long flags, final int data) {
if ((flags & F_FACING_LOW3D2_NSWE) != 0L) {
switch(data & 7) {
case 3:
return BlockFace.SOUTH;
case 4:
return BlockFace.WEST;
case 5:
return BlockFace.EAST;
default: // 2 and invalid states.
return BlockFace.NORTH;
}
}
else if ((flags & F_ATTACHED_LOW2_SNEW) != 0L) {
switch (data & 3) {
case 0:
return BlockFace.NORTH; // Attached to BlockFace.SOUTH;
case 1:
return BlockFace.SOUTH; // Attached to BlockFace.NORTH;
case 2:
return BlockFace.WEST; // Attached to BlockFace.EAST;
case 3:
return BlockFace.EAST; // Attached to BlockFace.WEST;
}
}
return null;
}
/**
* Special case: Trap door above ladder attached to lower and of block, same
* facing. Thus the trap door can be climbed up like a ladder.<br>
* Suggested fast precondition checks are for nearby flags covering this and
* below:
* <ul>
* <li>F_PASSABLE_X4 (trap door at these coordinates).</li>
* <li>F_CLIMBABLE (ladder below).</li>
* </ul>
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @return true, if is trap door above ladder special case
*/
public static final boolean isTrapDoorAboveLadderSpecialCase(final BlockCache access,
final int x, final int y, final int z) {
// Special case activation.
if (!isSpecialCaseTrapDoorAboveLadder()) {
return false;
}
// Basic flags and facing for trap door.
final long flags1 = getBlockFlags(access.getType(x, y, z));
if ((flags1 & F_PASSABLE_X4) == 0) {
return false;
}
// TODO: Really confine to trap door types (add a flag or something else)?
final int data1 = access.getData(x, y, z);
// (Trap door may be attached to top or bottom, regardless.)
// Trap door must be open (really?).
if ((data1 & 0x04) != 0x04) {
return false;
}
// Need the facing direction.
final BlockFace face1 = getFacing(flags1, data1);
if (face1 == null) {
return false;
}
// Basic flags and facing for ladder.
final Material belowId = access.getType(x, y - 1, z);
// Really confine to ladder here.
if (belowId != Material.LADDER) {
return false;
}
final long flags2 = getBlockFlags(belowId);
// (Type has already been checked.)
//if ((flags2 & F_CLIMBABLE) == 0) {
// return false;
//}
final int data2 = access.getData(x, y - 1, z);
final BlockFace face2 = getFacing(flags2, data2);
// Compare faces.
if (face1 != face2) {
return false;
}
return true;
}
/**
* Just check if a position is not inside of a block that has a bounding
* box.<br>
* This is an inaccurate check, it also returns false for doors etc.
*
* @param blockType
* the block type
* @return true, if is passable
*/
public static final boolean isPassable(final Material blockType) {
final long flags = getBlockFlags(blockType);
// TODO: What with non-solid blocks that are not passable ?
if ((flags & (F_LIQUID | F_IGN_PASSABLE)) != 0) {
return true;
}
else {
// TODO: F_GROUND ?
return (flags & F_SOLID) == 0;
}
}
/**
* All rail types a minecart can move on.
*
* @param id
* the id
* @return true, if is rails
*/
public static final boolean isRails(final Material id) {
return (getBlockFlags(id) & F_RAILS) != 0;
}
/**
* Test if the id is rails and if data means ascending.
*
* @param id
* the id
* @param data
* the data
* @return true, if is ascending rails
*/
public static final boolean isAscendingRails(final Material id, final int data) {
// TODO: Configurable magic.
return isRails(id) && (data & 7) > 1;
}
/**
* Test if a position can be passed through (collidesBlock + passable test,
* no fences yet).<br>
* NOTE: This is experimental.
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param node
* The IBlockCacheNode instance for the given block coordinates.
* Not null.
* @param nodeAbove
* The IBlockCacheNode instance above the given block
* coordinates. May be null.
* @return true, if is passable
*/
public static final boolean isPassable(final BlockCache access,
final double x, final double y, final double z,
final IBlockCacheNode node, final IBlockCacheNode nodeAbove) {
final Material id = node.getType();
// Simple exclusion check first.
if (isPassable(id)) {
return true;
}
// Check if the position is inside of a bounding box.
// TODO: Consider to pass these as arguments too.
final int bx = Location.locToBlock(x);
final int by = Location.locToBlock(y);
final int bz = Location.locToBlock(z);
if (node.hasNonNullBounds() == AlmostBoolean.NO
|| !collidesBlock(access, x, y, z, x, y, z, bx, by, bz, node, nodeAbove, getBlockFlags(id))) {
return true;
}
final double fx = x - bx;
final double fy = y - by;
final double fz = z - bz;
// TODO: Check f_itchy if/once exists.
// Check workarounds (blocks with bigger collision box but passable on some spots).
if (!isPassableWorkaround(access, bx, by, bz, fx, fy, fz, node, 0, 0, 0, 0)) {
// Not passable.
return false;
}
return true;
}
/**
* Checking the block below to account for fences and such. This must be
* called extra to isPassable(...).
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @return true, if is passable h150
*/
public static final boolean isPassableH150(final BlockCache access,
final double x, final double y, final double z) {
// Check for fences.
final int by = Location.locToBlock(y) - 1;
final double fy = y - by;
if (fy >= 1.5) {
return true;
}
final int bx = Location.locToBlock(x);
final int bz = Location.locToBlock(z);
final IBlockCacheNode nodeBelow = access.getOrCreateBlockCacheNode(x, y, z, false);
final Material belowId = nodeBelow.getType();
final long belowFlags = getBlockFlags(belowId);
if ((belowFlags & F_HEIGHT150) == 0 || isPassable(belowId)) {
return true;
}
final double[] belowBounds = nodeBelow.getBounds(access, bx, by, bz);
if (belowBounds == null) {
return true;
}
if (!collidesBlock(access, x, y, z, x, y, z, bx, by, bz, nodeBelow, null, belowFlags)) {
return true;
}
final double fx = x - bx;
final double fz = z - bz;
return isPassableWorkaround(access, bx, by, bz, fx, fy, fz, nodeBelow, 0, 0, 0, 0);
}
/**
* Check if passable, including blocks with height 1.5.
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param id
* the id
* @return true, if is passable exact
*/
public static final boolean isPassableExact(final BlockCache access,
final double x, final double y, final double z) {
return isPassable(access, x, y, z, access.getOrCreateBlockCacheNode(x, y, z, false), null) && isPassableH150(access, x, y, z);
}
/**
* Check if passable, including blocks with height 1.5.
*
* @param access
* the access
* @param loc
* the loc
* @return true, if is passable exact
*/
public static final boolean isPassableExact(final BlockCache access, final Location loc) {
return isPassableExact(access, loc.getX(), loc.getY(), loc.getZ());
}
/**
* Requires the hit-box of the block is hit (...): this checks for special
* blocks properties such as glass panes and similar.<br>
* Ray-tracing version for passable-workarounds.
*
* @param access
* the access
* @param bx
* Block-coordinates.
* @param by
* the by
* @param bz
* the bz
* @param fx
* Offset from block-coordinates in [0..1].
* @param fy
* the fy
* @param fz
* the fz
* @param node
* The IBlockCacheNode instance for the given block coordinates.
* @param dX
* Total ray distance for coordinated (see dT).
* @param dY
* the d y
* @param dZ
* the d z
* @param dT
* Time to cover from given position in [0..1], relating to dX,
* dY, dZ.
* @return true, if is passable workaround
*/
public static final boolean isPassableWorkaround(final BlockCache access,
final int bx, final int by, final int bz,
final double fx, final double fy, final double fz,
final IBlockCacheNode node,
final double dX, final double dY, final double dZ,
final double dT) {
// Note: Since this is only called if the bounding box collides, out-of-bounds checks should not be necessary.
// TODO: Add a flag if a workaround exists (!), might store the type of workaround extra (generic!), or extra flags.
final Material id = node.getType();
final long flags = getBlockFlags(id);
if ((flags & F_STAIRS) != 0) {
if ((access.getData(bx, by, bz) & 0x4) != 0) {
if (Math.max(fy, fy + dY * dT) < 0.5) {
return true;
}
}
else {
// what with >= 1?
if (Math.min(fy, fy + dY * dT) >= 0.5) {
return true;
}
}
}
else if (id == Material.SOUL_SAND) {
if (Math.min(fy, fy + dY * dT) >= 0.875) {
return true; // 0.125
}
}
else if ((flags & F_PASSABLE_X4) != 0 && (access.getData(bx, by, bz) & 0x4) != 0) {
// (Allow checking further entries.)
return true;
}
else if ((flags & F_THICK_FENCE) != 0) {
if (!collidesFence(fx, fz, dX, dZ, dT, 0.125)) {
return true;
}
}
else if ((flags & F_THIN_FENCE) != 0) {
if (!collidesFence(fx, fz, dX, dZ, dT, 0.05)) {
return true;
}
}
else if (id == BridgeMaterial.CAKE) {
if (Math.min(fy, fy + dY * dT) >= 0.4375) {
return true; // 0.0625 = 0.125 / 2
}
}
else if (id == Material.CAULDRON) {
if (Math.min(fy, fy + dY * dT) >= 0.3125) {
// Check for moving through walls or floor.
// TODO: Maybe this is too exact...
return isInsideCenter(fx, fz, dX, dZ, dT, 0.125);
}
}
else if (id == Material.CACTUS) {
if (Math.min(fy, fy + dY * dT) >= 0.9375) {
return true;
}
return !collidesCenter(fx, fz, dX, dZ, dT, 0.0625);
}
else if (id == BridgeMaterial.PISTON_HEAD) {
if (Math.min(fy, fy + dY * dT) >= 0.625) {
return true;
}
}
else if ((flags & F_GROUND_HEIGHT) != 0
&& getGroundMinHeight(access, bx, by, bz, node, flags) <= Math.min(fy, fy + dY * dT)) {
return true;
}
// Nothing found.
return false;
}
/**
* XZ-collision check for (bounds / pseudo-ray) with fence type blocks
* (fences, glass panes), margin configurable.
*
* @param fx
* the fx
* @param fz
* the fz
* @param dX
* the d x
* @param dZ
* the d z
* @param dT
* the d t
* @param d
* Distance to the fence middle to keep (see code of
* isPassableworkaround for reference).
* @return true, if successful
*/
public static boolean collidesFence(final double fx, final double fz,
final double dX, final double dZ, final double dT, final double d) {
final double dFx = 0.5 - fx;
final double dFz = 0.5 - fz;
if (Math.abs(dFx) > d && Math.abs(dFz) > d) {
// Check moving between quadrants.
final double dFx2 = 0.5 - (fx + dX * dT);
final double dFz2 = 0.5 - (fz + dZ * dT);
if (Math.abs(dFx2) > d && Math.abs(dFz2) > d) {
if (dFx * dFx2 > 0.0 && dFz * dFz2 > 0.0) {
return false;
}
}
}
return true;
}
/**
* Collision for x-z ray / bounds. Use this to check if a box is really
* outside.
*
* @param fx
* the fx
* @param fz
* the fz
* @param dX
* the d x
* @param dZ
* the d z
* @param dT
* the d t
* @param inset
* the inset
* @return False if no collision with the center bounds.
*/
public static final boolean collidesCenter(final double fx, final double fz,
final double dX, final double dZ, final double dT, final double inset) {
final double low = inset;
final double high = 1.0 - inset;
final double xEnd = fx + dX * dT;
if (xEnd < low && fx < low) {
return false;
}
else if (xEnd >= high && fx >= high) {
return false;
}
final double zEnd = fz + dZ * dT;
if (zEnd < low && fz < low) {
return false;
}
else if (zEnd >= high && fz >= high) {
return false;
}
return true;
}
/**
* Collision for x-z ray / bounds. Use this to check if a box is really
* inside.
*
* @param fx
* the fx
* @param fz
* the fz
* @param dX
* the d x
* @param dZ
* the d z
* @param dT
* the d t
* @param inset
* the inset
* @return True if the box is really inside of the center bounds.
*/
public static final boolean isInsideCenter(final double fx, final double fz,
final double dX, final double dZ, final double dT, final double inset) {
final double low = inset;
final double high = 1.0 - inset;
final double xEnd = fx + dX * dT;
if (xEnd < low || fx < low) {
return false;
}
else if (xEnd >= high || fx >= high) {
return false;
}
final double zEnd = fz + dZ * dT;
if (zEnd < low || fz < low) {
return false;
}
else if (zEnd >= high || fz >= high) {
return false;
}
return true;
}
/**
* Reference block height for on-ground judgment: player must be at this or
* greater height to stand on this block.<br>
* <br>
* TODO: Check naming convention, might change to something with max ...
* volatile! <br>
* This might return 0 or somewhat arbitrary values for some blocks that
* don't have full bounds (!), might return 0 for blocks with the
* F_GROUND_HEIGHT flag, unless they are treated individually here.
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param node
* The node at the given block coordinates.
* @param flags
* Flags for this block.
* @return the ground min height
*/
public static double getGroundMinHeight(final BlockCache access,
final int x, final int y, final int z,
final IBlockCacheNode node, final long flags) {
final Material id = node.getType();
final double[] bounds = node.getBounds(access, x, y, z);
// TODO: Check which ones are really needed !
if ((flags & F_HEIGHT_8SIM_INC) != 0) {
final int data = (node.getData(access, x, y, z) & 0xF) % 8;
if (data < 3) {
return 0;
}
else {
return 0.5;
}
}
else if ((flags & F_HEIGHT_8_INC) != 0) {
final int data = (node.getData(access, x, y, z) & 0xF) % 8;
return 0.125 * (double) data;
}
// Height 100 is ignored (!).
else if ((flags & F_HEIGHT150) != 0) {
return 1.5;
}
else if ((flags & F_STAIRS) != 0) {
if ((node.getData(access, x, y, z) & 0x4) != 0) {
return 1.0;
}
else {
// what with >= 1?
return 0.5;
}
}
else if ((flags & F_THICK_FENCE) != 0) {
return Math.min(1.0, bounds[4]);
}
else if (id == Material.SOUL_SAND) {
return 0.875;
}
// else if (id == BridgeMaterial.CAKE.getId()) {
// return 0.4375;
// }
else if (id == Material.CAULDRON) {
// TODO: slightly over 0.
return 0.3125;
}
else if (id == Material.CACTUS) {
return 0.9375;
}
else if (id == BridgeMaterial.PISTON_HEAD) {
return 0.625;
}
else if (id == BridgeMaterial.END_PORTAL_FRAME) {
// Allow moving as if no eye was inserted.
return 0.8125;
}
else if (bounds == null) {
return 0.0;
}
else if ((flags & F_GROUND_HEIGHT) != 0) {
// Subsequent min height flags.
if ((flags & F_MIN_HEIGHT16_1) != 0) {
// 1/16
return 0.0625;
}
if ((flags & F_MIN_HEIGHT16_15) != 0) {
// 15/16
return 0.9375;
}
// Default height is used.
if (id == BridgeMaterial.FARMLAND) {
return bounds[4];
}
// Assume open gates/trapdoors/things to only allow standing on to, if at all.
if ((flags & F_PASSABLE_X4) != 0 && (node.getData(access, x, y, z) & 0x04) != 0) {
return bounds[4];
}
// All blocks that are not treated individually are ground all through.
return 0;
}
else {
// Nothing found.
// TODO: Consider using Math.min(1.0, bounds[4]) for compatibility rather?
return bounds[4];
}
}
/**
* Convenience method for debugging purposes.
*
* @param loc
* the loc
* @return true, if is passable
*/
public static final boolean isPassable(final PlayerLocation loc) {
return isPassable(loc.getBlockCache(), loc.getX(), loc.getY(), loc.getZ(), loc.getOrCreateBlockCacheNode(), null);
}
/**
* Convenience method.
*
* @param loc
* the loc
* @return true, if is passable
*/
public static final boolean isPassable(final Location loc) {
return isPassable(loc.getWorld(), loc.getX(), loc.getY(), loc.getZ());
}
/**
* Convenience method.
*
* @param world
* the world
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @return true, if is passable
*/
public static final boolean isPassable(final World world, final double x, final double y, final double z) {
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(world);
boolean res = isPassable(blockCache, x, y, z, blockCache.getOrCreateBlockCacheNode(x, y, z, false), null);
blockCache.cleanup();
return res;
}
/**
* Normal ray tracing.
*
* @param from
* the from
* @param to
* the to
* @return true, if is passable
*/
public static final boolean isPassable(final Location from, final Location to) {
return isPassable(rtRay, from, to);
}
/**
* Axis-wise checking, like the client does.
*
* @param from
* the from
* @param to
* the to
* @return true, if is passable axis wise
*/
public static final boolean isPassableAxisWise(final Location from, final Location to) {
return isPassable(rtAxis, from, to);
}
/**
* Checks if is passable.
*
* @param rt
* the rt
* @param from
* the from
* @param to
* the to
* @return true, if is passable
*/
private static boolean isPassable(final ICollidePassable rt, final Location from, final Location to) {
final BlockCache blockCache = wrapBlockCache.getBlockCache();
blockCache.setAccess(from.getWorld());
rt.setMaxSteps(60); // TODO: Configurable ?
rt.setBlockCache(blockCache);
rt.set(from.getX(), from.getY(), from.getZ(), to.getX(), to.getY(), to.getZ());
rt.loop();
final boolean collides = rt.collides();
blockCache.cleanup();
rt.cleanup();
return !collides;
}
/**
* Convenience method to allow using an already fetched or prepared
* IBlockAccess.
*
* @param access
* the access
* @param loc
* the loc
* @return true, if is passable
*/
public static final boolean isPassable(final BlockCache access, final Location loc)
{
return isPassable(access, loc.getX(), loc.getY(), loc.getZ(), access.getOrCreateBlockCacheNode(loc.getBlockX(), loc.getBlockY(), loc.getBlockZ(), false), null);
}
/**
* API access to read extra properties from files.
*
* @param config
* the config
* @param pathPrefix
* the path prefix
*/
public static void applyConfig(final RawConfigFile config, final String pathPrefix) {
// Breaking time overrides for specific side conditions.
ConfigurationSection section = config.getConfigurationSection(pathPrefix + ConfPaths.SUB_BREAKINGTIME);
for (final String input : section.getKeys(false)) {
try {
BlockProperties.setBreakingTimeOverride(new BlockBreakKey().fromString(input.trim()),
section.getLong(input));
}
catch (Exception e) {
StaticLog.logWarning("Bad breaking time override (" + pathPrefix + ConfPaths.SUB_BREAKINGTIME + "): " + input);
StaticLog.logWarning(e);
}
}
// Allow instant breaking.
for (final String input : config.getStringList(pathPrefix + ConfPaths.SUB_ALLOWINSTANTBREAK)) {
final Material id = RawConfigFile.parseMaterial(input);
if (id == null) {
StaticLog.logWarning("Bad block id (" + pathPrefix + ConfPaths.SUB_ALLOWINSTANTBREAK + "): " + input);
}
else {
setBlockProps(id, instantType);
}
}
// Override block flags.
section = config.getConfigurationSection(pathPrefix + ConfPaths.SUB_OVERRIDEFLAGS);
if (section != null) {
final Map<String, Object> entries = section.getValues(false);
boolean hasErrors = false;
for (final Entry<String, Object> entry : entries.entrySet()) {
final String key = entry.getKey();
final Material id = RawConfigFile.parseMaterial(key);
if (id == null) {
StaticLog.logWarning("Bad block id (" + pathPrefix + ConfPaths.SUB_OVERRIDEFLAGS + "): " + key);
continue;
}
final Object obj = entry.getValue();
if (!(obj instanceof String)) {
StaticLog.logWarning("Bad flags at " + pathPrefix + ConfPaths.SUB_OVERRIDEFLAGS + " for key: " + key);
hasErrors = true;
continue;
}
final Collection<String> split = StringUtil.split((String) obj, ' ', ',', '/', '|', '+', ';', '\t');
long flags = 0;
boolean error = false;
for (String input : split) {
input = input.trim();
if (input.isEmpty()) {
continue;
}
else if (input.equalsIgnoreCase("default")) {
flags |= getBlockFlags(id);
continue;
}
try{
flags |= parseFlag(input);
} catch(InputMismatchException e) {
StaticLog.logWarning("Bad flag at " + pathPrefix + ConfPaths.SUB_OVERRIDEFLAGS + " for key " + key + " (skip setting flags for this block): " + input);
error = true;
hasErrors = true;
break;
}
}
if (error) {
continue;
}
setBlockFlags(id, flags);
}
if (hasErrors) {
StaticLog.logInfo("Overriding block-flags was not entirely successful, all available flags: \n" + StringUtil.join(flagNameMap.values(), "|"));
}
}
}
/**
* Test if the bounding box overlaps with a block of given flags (does not
* check the blocks bounding box).
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param flags
* Block flags (@see
* fr.neatmonster.nocheatplus.utilities.BlockProperties).
* @return If any block has the flags.
*/
public static final boolean hasAnyFlags(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final long flags) {
return hasAnyFlags(access, Location.locToBlock(minX), Location.locToBlock(minY), Location.locToBlock(minZ), Location.locToBlock(maxX), Location.locToBlock(maxY), Location.locToBlock(maxZ), flags);
}
/**
* Test if the bounding box overlaps with a block of given flags (does not
* check the blocks bounding box).
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param flags
* Block flags (@see
* fr.neatmonster.nocheatplus.utilities.BlockProperties).
* @return If any block has the flags.
*/
public static final boolean hasAnyFlags(final BlockCache access,
final int minX, final int minY, final int minZ,
final int maxX, final int maxY, final int maxZ,
final long flags) {
for (int x = minX; x <= maxX; x++) {
for (int z = minZ; z <= maxZ; z++) {
for (int y = minY; y <= maxY; y++) {
if ((getBlockFlags(access.getType(x, y, z)) & flags) != 0) {
return true;
}
}
}
}
return false;
}
/**
* Test if the box collide with any block that matches the flags somehow.
* Convenience method.
*
* @param access
* the access
* @param bounds
* 'Classic' bounds as returned for blocks (minX, minY, minZ,
* maxX, maxY, maxZ).
* @param flags
* The flags to match.
* @return true, if successful
*/
public static final boolean collides(final BlockCache access, double[] bounds, final long flags) {
return collides(access, bounds[0], bounds[1], bounds[2], bounds[3], bounds[4], bounds[5], flags);
}
/**
* Test if the box collide with any block that matches the flags somehow.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param flags
* The flags to match.
* @return true, if successful
*/
public static final boolean collides(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final long flags) {
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
// At least find fences etc. if searched for.
// TODO: F_HEIGHT150 could also be ground etc., more consequent might be to always use or flag it.
final int iMinY = Location.locToBlock(minY - ((flags & F_HEIGHT150) != 0 ? 0.5625 : 0));
final int iMaxY = Math.min(Location.locToBlock(maxY), access.getMaxBlockY());
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
IBlockCacheNode nodeAbove = null;
for (int y = iMaxY; y >= iMinY; y--) {
final IBlockCacheNode node = access.getOrCreateBlockCacheNode(x, y, z, false);
final Material id = node.getType();
final long cFlags = getBlockFlags(id);
if ((cFlags & flags) != 0) {
// Might collide.
if (node.hasNonNullBounds().decideOptimistically()
&& collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, x, y, z, node, nodeAbove, cFlags)) {
return true;
}
}
nodeAbove = node;
}
}
}
return false;
}
/**
* Convenience method for Material instead of block id.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param mat
* the mat
* @return true, if successful
*/
public static final boolean collidesId(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final Material mat) {
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY - ((getBlockFlags(mat) & F_HEIGHT150) != 0 ? 0.5625 : 0));
final int iMaxY = Location.locToBlock(maxY);
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
for (int y = iMinY; y <= iMaxY; y++) {
if (mat == access.getType(x, y, z)) {
return true;
}
}
}
}
return false;
}
/**
* Check if the given bounding box collides with a block of the given id,
* taking into account the actual bounds of the block.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param id
* the id
* @return true, if successful
*/
public static final boolean collidesBlock(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final Material id) {
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY - ((getBlockFlags(id) & F_HEIGHT150) != 0 ? 0.5625 : 0));
final int iMaxY = Math.min(Location.locToBlock(maxY), access.getMaxBlockY());
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
final long flags = getBlockFlags(id);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
IBlockCacheNode nodeAbove = null;
for (int y = iMaxY; y >= iMinY; y--) {
final IBlockCacheNode node = access.getOrCreateBlockCacheNode(x, y, z, false);
if (id == node.getType()) {
if (node.hasNonNullBounds().decideOptimistically()) {
if (collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, x, y, z, node, nodeAbove, flags)) {
return true;
}
}
}
}
}
}
return false;
}
// /**
// * Check if the bounds collide with the block that has the given type id at
// * the given position. <br>
// * Delegates: This method signature is not used internally anymore.
// *
// * @param access
// * the access
// * @param minX
// * the min x
// * @param minY
// * the min y
// * @param minZ
// * the min z
// * @param maxX
// * the max x
// * @param maxY
// * the max y
// * @param maxZ
// * the max z
// * @param x
// * the x
// * @param y
// * the y
// * @param z
// * the z
// * @param id
// * the id
// * @return true, if successful
// */
// public static final boolean collidesBlock(final BlockCache access, final double minX, double minY, final double minZ, final double maxX, final double maxY, final double maxZ, final int x, final int y, final int z, final int id) {
// // TODO: use internal block data unless delegation wanted?
// final double[] bounds = access.getBounds(x,y,z);
// if (bounds == null) {
// return false; // TODO: policy ?
// }
// final long flags = blockFlags[id];
// return collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, x, y, z, id, bounds, flags);
// }
/**
* Check if the bounds collide with the block for the given type id at the
* given position. This does not check workarounds for ground_height nor
* passable.
*
* @param access
* the access <- we all love the access!
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param node
* The node at the given block coordinates (not null, bounds need
* not be fetched).
* @param nodeAbove
* The node above the given block coordinates (may be null). Pass
* for efficiency, if it should already have been fetched for
* some reason.
* @param flags
* Block flags for the block at x, y, z. Mix in F_COLLIDE_EDGES
* to disallow the "high edges" of blocks.
* @return true, if successful
*/
public static final boolean collidesBlock(final BlockCache access,
final double minX, double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final int x, final int y, final int z,
final IBlockCacheNode node, final IBlockCacheNode nodeAbove,
final long flags) {
/*
* TODO: Not sure with the flags parameter, these days. Often a
* pre-check using flags is done ... array access vs. passing an
* argument (+ JIT) - would be better to have a 100+ player server to
* take profiling data just for testing such differences.
*/
final double[] bounds = node.getBounds(access, x, y, z);
if (bounds == null) {
return false;
}
final double bminX, bminZ, bminY;
final double bmaxX, bmaxY, bmaxZ;
// TODO: Consider a quick shortcut checks flags == F_NORMAL_GROUND
if ((flags & F_STAIRS) != 0) { // TODO: make this a full block flag ?
// Mainly for on ground style checks, would not go too well with passable.
// TODO: change this to something like F_FULLBOX probably.
bminX = bminY = bminZ = 0D;
bmaxX = bmaxY = bmaxZ = 1D;
}
else {
// xz-bounds
if ((flags & F_XZ100) != 0) {
bminX = bminZ = 0;
bmaxX = bmaxZ = 1;
}
else {
bminX = bounds[0]; // block.v(); // minX
bminZ = bounds[2]; // block.z(); // minZ
bmaxX = bounds[3]; //block.w(); // maxX
bmaxZ = bounds[5]; //block.A(); // maxZ
}
// y-bounds
if ((flags & F_HEIGHT_8SIM_INC) != 0) {
// TODO: remove / solve differently ?
bminY = 0;
final int data = (node.getData(access, x, y, z) & 0xF) % 8;
// bmaxY = (double) (1 + data) / 8.0;
bmaxY = data < 3 ? 0 : 0.5;
}
else if ((flags & F_HEIGHT_8_INC) != 0) {
bminY = 0;
final int data = (node.getData(access, x, y, z) & 0xF) % 8;
bmaxY = 0.125 * data;
}
else if ((flags & F_HEIGHT150) != 0) {
bminY = 0;
bmaxY = 1.5;
}
else if ((flags & F_HEIGHT100) != 0) {
bminY = 0;
bmaxY = 1.0;
}
else if ((flags & F_HEIGHT_8SIM_DEC) != 0) {
bminY = 0;
final int data = node.getData(access, x, y, z);
if ((data & 0x8) == 0) {
// This box works for jumping over flowing water.
// bmaxY = (0.8 - (double) ((data & 0xF) % 8) / 9.8);
final int data8 = (data & 0xF) % 8;
if (data8 > 4) {
// TODO: With block breaking and data8 == 7 this would be too high.
bmaxY = 0.5;
}
else {
//bmaxY = 1.0; // - (double) data8 / 9.0;
bmaxY = shouldLiquidBelowBeFullHeight(access, x, y + 1, z, nodeAbove) ? 1.0 : LIQUID_HEIGHT_LOWERED;
}
}
else {
//bmaxY = 1.0;
bmaxY = shouldLiquidBelowBeFullHeight(access, x, y + 1, z, nodeAbove) ? 1.0 : LIQUID_HEIGHT_LOWERED;
}
}
else if ((flags & F_HEIGHT8_1) != 0) {
bminY = 0.0;
bmaxY = 0.125;
}
else if (node.getType() == BridgeMaterial.END_PORTAL_FRAME) {
// TODO: Test
// TODO: Other concepts ...
bminY = 0;
if ((node.getData(access, x, y, z) & 0x04) != 0) {
bmaxY = 1.0;
} else {
bmaxY = 0.8125;
}
}
else {
bminY = bounds[1]; // minY
bmaxY = bounds[4]; // maxY
}
}
// Clearly outside of bounds.
if (minX > bmaxX + x || maxX < bminX + x
|| minY > bmaxY + y || maxY < bminY + y
|| minZ > bmaxZ + z || maxZ < bminZ + z) {
return false;
}
// Hitting the max-edges (if allowed).
final boolean allowEdge = (flags & F_COLLIDE_EDGES) == 0;
if (minX == bmaxX + x && (bmaxX < 1.0 || allowEdge)
|| minY == bmaxY + y && (bmaxY < 1.0 || allowEdge)
|| minZ == bmaxZ + z && (bmaxZ < 1.0 || allowEdge)) {
return false;
}
// Collision.
return true;
}
// TODO: Consider for convenience ?
// /**
// * Determine if the liquid block below has full height or not (provided it
// * is max. level).
// *
// * @param access
// * the access
// * @param x
// * Coordinates of the block above the liquid block in question.
// * @param y
// * the y
// * @param z
// * the z
// * @return true, if successful
// */
// public static boolean shouldLiquidBelowBeFullHeight(final BlockCache access, final int x, final int y, final int z) {
// return shouldLiquidBelowBeFullHeight(access, x, y, z, null);
// }
/**
* Determine if the liquid block below has full height or not (provided it
* is max. level).
*
* @param access
* @param x
* Coordinates of the block above the liquid block in question.
* @param y
* @param z
* @param node
* The IBlockCacheNode instance for the given coordinates, may be null.
* @return
*/
public static boolean shouldLiquidBelowBeFullHeight(final BlockCache access,
final int x, final int y, final int z,
IBlockCacheNode node) {
if (node == null) {
node = access.getOrCreateBlockCacheNode(x, y, z, false);
}
final Material id = node.getType();
if (isLiquid(id)) {
return true;
}
if (!isSolid(id)) {
return false;
}
final double[] bounds = getCorrectedBounds(access, x, y, z, node);
// TODO: Implement corrected bounds.
// TODO: Fences ~ test.
return bounds == null ? true : (bounds[1] == 0.0);
}
/**
* Attempt to return the exact outside bounds, corrected by flags and other.
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @return If changed, a copy is returned, otherwise the original bounds
* returned by the BlockCache instance.
* @deprecated Not yet for real (only used in certain checks/contexts).
*/
public static double[] getCorrectedBounds(final BlockCache access, final int x, final int y, final int z) {
return getCorrectedBounds(access, x, y, z, access.getOrCreateBlockCacheNode(x, y, z, false));
}
/**
* Attempt to return the exact outside bounds, corrected by flags and other.
*
* @param access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param node
* Not null.
* @param bounds
* the bounds
* @return If changed, a copy is returned, otherwise the original array as
* given.
* @deprecated Not yet for real (only used in certain checks/contexts).
*/
public static double[] getCorrectedBounds(final BlockCache access, final int x, final int y, final int z,
final IBlockCacheNode node) {
final double[] bounds = node.getBounds(access, x, y, z);
if (bounds == null) {
return null;
}
//final long flags = blockFlags[id];
// TODO: Consider to change to adaptBounds and to store the adapted bounds already.
// TODO: IMPLEMENT special bounds, at least: Step + stairs (dy=0.5 for both) + snow.
return bounds;
}
/**
* Like isOnGround, just with minimum and maximum coordinates in arbitrary
* order.
*
* @param access
* the access
* @param x1
* the x1
* @param y1
* the y1
* @param z1
* the z1
* @param x2
* the x2
* @param y2
* the y2
* @param z2
* the z2
* @param xzMargin
* Subtracted from minima and added to maxima.
* @param yBelow
* Subtracted from the minimum of y.
* @param yAbove
* Added to the maximum of y.
* @return true, if is on ground shuffled
*/
public static final boolean isOnGroundShuffled(final BlockCache access,
final double x1, final double y1, final double z1,
final double x2, final double y2, final double z2,
final double xzMargin, final double yBelow, final double yAbove) {
return isOnGroundShuffled(access, x1, y1, z1, x2, y2, z2, xzMargin, yBelow, yAbove, 0L);
}
/**
* Similar to collides(... , F_GROUND), but also checks the block above
* (against spider).<br>
* NOTE: This does not return true if stuck, to check for that use
* collidesBlock for the players location.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @return true, if is on ground
*/
public static final boolean isOnGround(final BlockCache access,
final double minX, double minY, final double minZ,
final double maxX, final double maxY, final double maxZ) {
return isOnGround(access, minX, minY, minZ, maxX, maxY, maxZ, 0L);
}
/**
* Like isOnGround, just with minimum and maximum coordinates in arbitrary
* order.
*
* @param access
* the access
* @param x1
* the x1
* @param y1
* the y1
* @param z1
* the z1
* @param x2
* the x2
* @param y2
* the y2
* @param z2
* the z2
* @param xzMargin
* Subtracted from minima and added to maxima.
* @param yBelow
* Subtracted from the minimum of y.
* @param yAbove
* Added to the maximum of y.
* @param ignoreFlags
* the ignore flags
* @return true, if is on ground shuffled
*/
public static final boolean isOnGroundShuffled(final BlockCache access,
final double x1, double y1, final double z1,
final double x2, final double y2, final double z2,
final double xzMargin, final double yBelow, final double yAbove,
final long ignoreFlags) {
return isOnGround(access, Math.min(x1, x2) - xzMargin, Math.min(y1, y2) - yBelow, Math.min(z1, z2) - xzMargin, Math.max(x1, x2) + xzMargin, Math.max(y1, y2) + yAbove, Math.max(z1, z2) + xzMargin, ignoreFlags);
}
/**
* Similar to collides(... , F_GROUND), but also checks the block above
* (against spider).<br>
* NOTE: This does not return true if stuck, to check for that use
* collidesBlock for the players location.
*
* @param access
* the access
* @param minX
* Bounding box coordinates...
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* Meant to be the foot-level.
* @param maxZ
* the max z
* @param ignoreFlags
* Blocks with these flags are not counted as ground.
* @return true, if is on ground
*/
public static final boolean isOnGround(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final long ignoreFlags) {
final int maxBlockY = access.getMaxBlockY();
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY - 0.5626);
if (iMinY > maxBlockY) {
return false;
}
final int iMaxY = Math.min(Location.locToBlock(maxY), maxBlockY);
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
IBlockCacheNode nodeAbove = null; // (Lazy fetch/update only.)
for (int y = iMaxY; y >= iMinY; y --) {
final IBlockCacheNode node = access.getOrCreateBlockCacheNode(x, y, z, false);
switch(isOnGround(access, minX, minY, minZ, maxX, maxY, maxZ,
ignoreFlags, x, y, z, node, nodeAbove)) {
case YES:
return true;
case MAYBE:
nodeAbove = node;
continue;
case NO:
break;
}
break; // case NO
}
}
}
return false;
}
/**
* Check for ground at a certain block position, assuming checking order is
* top down within an x-z loop.
*
* @param access
* @param minX
* @param minY
* @param minZ
* @param maxX
* @param maxY
* @param maxZ
* @param ignoreFlags
* @param x
* @param y
* @param z
* @param iMaxY
* Math.min(iteration max block y, world max block y)
* @param node
* @param nodeAbove
* May be null.
* @return YES if certainly on ground, MAYBE if not on ground with the
* possibility of being on ground underneath, NO if not on ground
* without the possibility to be on ground with checking lower
* y-coordinates.
*/
public static final AlmostBoolean isOnGround(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final long ignoreFlags,
final int x, final int y, final int z,
final IBlockCacheNode node, IBlockCacheNode nodeAbove) {
// TODO: Relevant methods called here should be changed to use IBlockCacheNode (node, nodeAbove).
final Material id = node.getType(); // TODO: Pass on the node (signatures...).
final long flags = getBlockFlags(id);
// TODO: LIQUID could be a quick return as well.
// (IGN_PASSABLE might still allow standing on.)
if ((flags & F_GROUND) == 0 || (flags & ignoreFlags) != 0) {
return AlmostBoolean.MAYBE;
}
// Might collide.
final double[] bounds = node.getBounds(access, x, y, z);
if (bounds == null) {
// TODO: Safety check, uncertain.
return AlmostBoolean.YES;
}
if (!collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, x, y, z, node, nodeAbove, flags)) {
return AlmostBoolean.MAYBE;
}
// TODO: Make this one work (passable workaround).
// Check if the block can be passed through with the bounding box (disregard the ignore flag).
if (isPassableWorkaround(access, x, y, z, minX - x, minY - y, minZ - z, node, maxX - minX, maxY - minY, maxZ - minZ, 1.0)) {
// Spider !
// Not nice but...
// TODO: GROUND_HEIGHT: would have to check passable workaround again ?
// TODO: height >= ?
// TODO: Another concept is needed for the stand-on-passable !
// TODO: Add getMinGroundHeight, getMaxGroundHeight.
if ((flags & F_GROUND_HEIGHT) == 0 || getGroundMinHeight(access, x, y, z, node, flags) > maxY - y) {
// Don't break, though could for some cases (?), since a block below still can be ground.
return AlmostBoolean.MAYBE;
}
}
// Don't count as ground if a block contains the foot.
// height >= ?
if (getGroundMinHeight(access, x, y, z, node, flags) > maxY - y) {
// Within block, this x and z is no candidate for ground.
if (isFullBounds(bounds)) {
return AlmostBoolean.NO;
}
else {
return AlmostBoolean.MAYBE;
}
}
if (maxY - y < 1.0) {
// No need to check the block above (half slabs, stairs).
return AlmostBoolean.YES;
}
// Check if the block above allows this to be ground.
if (y >= access.getMaxBlockY()) {
// Only air above.
return AlmostBoolean.YES;
}
// The commented out part below looks wrong.
// // TODO: Keep an eye on this one for exploits.
// if (y != iMaxY && !variable) {
// // Ground found and the block above is passable, no need to check above.
// return AlmostBoolean.YES;
// }
// TODO: Else if variable : continue ?
// TODO: Highest block is always the foot position, even if just below 1.0, a return true would be ok?
// Check above, ensure nodeAbove is set.
if (nodeAbove == null) {
nodeAbove = access.getOrCreateBlockCacheNode(x, y + 1, z, false);
}
final Material aboveId = nodeAbove.getType();
final long aboveFlags = getBlockFlags(aboveId);
if ((aboveFlags & F_IGN_PASSABLE) != 0) {
// Ignore these (Note for above block check before ground property).
// TODO: Should this always apply ?
return AlmostBoolean.YES;
}
if ((aboveFlags & F_GROUND) == 0 || (aboveFlags & F_LIQUID) != 0 || (aboveFlags & ignoreFlags) != 0) {
return AlmostBoolean.YES;
}
boolean variable = (flags & F_VARIABLE) != 0;
variable |= (aboveFlags & F_VARIABLE) != 0;
// Check if it is the same id (walls!) and similar.
if (!variable && id == aboveId) {
// Exclude stone walls "quickly", can not stand on.
if (isFullBounds(bounds)) {
return AlmostBoolean.NO;
}
else {
return AlmostBoolean.MAYBE;
}
}
// Check against spider type hacks.
final double[] aboveBounds = nodeAbove.getBounds(access, x, y + 1, z);
if (aboveBounds == null) {
return AlmostBoolean.YES;
}
// TODO: nodeAbove + nodeAboveAbove ?? [don't want to implement a block cache for entire past state handling yet ...]
// TODO: 1.49 might be obsolete !
if (!collidesBlock(access, minX, minY, minZ, maxX, Math.max(maxY, 1.49 + y), maxZ, x, y + 1, z, nodeAbove, null, aboveFlags)) {
return AlmostBoolean.YES;
}
// Check passable workaround without checking ignore flag.
if (isPassableWorkaround(access, x, y + 1, z, minX - x, minY - (y + 1), minZ - z, nodeAbove, maxX - minX, maxY - minY, maxZ - minZ, 1.0)) {
return AlmostBoolean.YES;
}
if (isFullBounds(aboveBounds)) {
// Can not be ground at this x - z position.
return AlmostBoolean.NO;
}
// TODO: Is this variable workaround still necessary ? Has this not been tested above already (passable workaround!)
// TODO: This might be seen as a violation for many block types.
// TODO: More distinction necessary here.
if (variable) {
// Simplistic hot fix attempt for same type + same shape.
// TODO: Needs passable workaround check.
if (isSameShape(bounds, aboveBounds)) {
// Can not stand on (rough heuristics).
// TODO: Test with cactus.
return AlmostBoolean.MAYBE; // There could be ground underneath (block vs. fence).
// continue;
}
else {
return AlmostBoolean.YES;
}
}
// Not regarded as ground,
return AlmostBoolean.MAYBE;
}
/**
* All dimensions 0 ... 1, no null checks.
*
* @param bounds
* Block bounds: minX, minY, minZ, maxX, maxY, maxZ
* @return true, if is full bounds
*/
public static final boolean isFullBounds(final double[] bounds) {
for (int i = 0; i < 3; i++) {
if (bounds[i] != 0.0 || bounds[i + 3] != 1.0) {
return false;
}
}
return true;
}
/**
* Check if the bounds are the same. With null checks.
*
* @param bounds1
* the bounds1
* @param bounds2
* the bounds2
* @return True, if the shapes have the exact same bounds, same if both are
* null. In case of one parameter being null, false is returned,
* even if the other is a full block.
*/
public static final boolean isSameShape(final double[] bounds1, final double[] bounds2) {
// TODO: further exclude simple full shape blocks, or confine to itchy block types
// TODO: make flags for it.
if (bounds1 == null || bounds2 == null) {
return bounds1 == bounds2;
}
// Allow as ground for differing shapes.
for (int i = 0; i < 6; i++) {
if (bounds1[i] != bounds2[i]) {
// Simplistic.
return false;
}
}
return true;
}
/**
* Check if the move given by from and to is leading downstream. Currently
* only the x-z move is regarded, no envelope/consistency checks are
* performed here, such as checking if the block is liquid at all, nor if
* the move makes sense. performed here.
*
* @param from
* the from
* @param to
* the to
* @return true, if is down stream
*/
public static final boolean isDownStream(final PlayerLocation from, final PlayerLocation to) {
return isDownStream(from.getBlockCache(),
from.getBlockX(), from.getBlockY(), from.getBlockZ(),
from.getData(), to.getX() - from.getX(), to.getZ() - from.getZ());
}
/**
* Check if a move determined by xDistance and zDistance is leading down
* stream.
*
* @param access
* the access
* @param x
* the x
* @param y
* the y
* @param z
* the z
* @param data
* the data
* @param dX
* the d x
* @param dZ
* the d z
* @return true, if is down stream
*/
public static final boolean isDownStream(final BlockCache access,
final int x, final int y, final int z, final int data,
final double dX, final double dZ) {
// x > 0 -> south, z > 0 -> west
if ((data & 0x8) == 0) {
// not falling.
if ((dX > 0)) {
if (data < 7 && BlockProperties.isLiquid(access.getType(x + 1, y, z)) && access.getData(x + 1, y, z) > data) {
return true;
}
else if (data > 0 && BlockProperties.isLiquid(access.getType(x - 1, y, z)) && access.getData(x - 1, y, z) < data) {
// reverse direction.
return true;
}
} else if (dX < 0) {
if (data < 7 && BlockProperties.isLiquid(access.getType(x - 1, y, z)) && access.getData(x - 1, y, z) > data) {
return true;
}
else if (data > 0 && BlockProperties.isLiquid(access.getType(x + 1, y, z)) && access.getData(x + 1, y, z) < data) {
// reverse direction.
return true;
}
}
if (dZ > 0) {
if (data < 7 && BlockProperties.isLiquid(access.getType(x, y, z + 1)) && access.getData(x, y, z + 1) > data) {
return true;
}
else if (data > 0 && BlockProperties.isLiquid(access.getType(x , y, z - 1)) && access.getData(x, y, z - 1) < data) {
// reverse direction.
return true;
}
}
else if (dZ < 0 ) {
if (data < 7 && BlockProperties.isLiquid(access.getType(x, y, z - 1)) && access.getData(x, y, z - 1) > data) {
return true;
}
else if (data > 0 && BlockProperties.isLiquid(access.getType(x , y, z + 1)) && access.getData(x, y, z + 1) < data) {
// reverse direction.
return true;
}
}
}
return false;
}
/**
* Collect all flags of blocks touched by the bounds, this does not check
* versus the blocks bounding box.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @return the long
*/
public static final long collectFlagsSimple(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ) {
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY);
final int iMaxY = Location.locToBlock(maxY);
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
// NCPAPIProvider.getNoCheatPlusAPI().getLogManager().debug(Streams.TRACE_FILE, "*** collect flags check size: " + ((iMaxX - iMinX + 1) * (iMaxY - iMinY + 1) * (iMaxZ - iMinZ + 1)));
long flags = 0;
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
for (int y = iMinY; y <= iMaxY; y++) {
flags |= getBlockFlags(access.getType(x, y, z));
}
}
}
return flags;
}
/**
* Penalty factor for block break duration if under water.
*
* @return the break penalty in water
*/
public static float getBreakPenaltyInWater() {
return breakPenaltyInWater;
}
/**
* Penalty factor for block break duration if under water.
*
* @param breakPenaltyInWater
* the new break penalty in water
*/
public static void setBreakPenaltyInWater(float breakPenaltyInWater) {
BlockProperties.breakPenaltyInWater = breakPenaltyInWater;
}
/**
* Penalty factor for block break duration if not on ground.
*
* @return the break penalty off ground
*/
public static float getBreakPenaltyOffGround() {
return breakPenaltyOffGround;
}
/**
* Penalty factor for block break duration if not on ground.
*
* @param breakPenaltyOffGround
* the new break penalty off ground
*/
public static void setBreakPenaltyOffGround(float breakPenaltyOffGround) {
BlockProperties.breakPenaltyOffGround = breakPenaltyOffGround;
}
/**
* Cleanup. Call init() to re-initialize.
*/
public static void cleanup() {
// (Null checks are error cases, to be intercepted elsewhere.)
if (pLoc != null) {
pLoc.cleanup();
pLoc = null;
}
if (wrapBlockCache != null) {
wrapBlockCache.cleanup();
wrapBlockCache = null;
}
// TODO: might empty mappings...
}
/**
* Checks if is passable ray.
*
* @param access
* the access
* @param blockX
* Block location.
* @param blockY
* the block y
* @param blockZ
* the block z
* @param oX
* Origin / offset from block location.
* @param oY
* the o y
* @param oZ
* the o z
* @param dX
* Direction (multiplied by dT to get end point of move).
* @param dY
* the d y
* @param dZ
* the d z
* @param dT
* the d t
* @return true, if is passable ray
*/
public static final boolean isPassableRay(final BlockCache access,
final int blockX, final int blockY, final int blockZ,
final double oX, final double oY, final double oZ,
final double dX, final double dY, final double dZ,
final double dT) {
// TODO: Method signature with node, nodeAbove.
final IBlockCacheNode node = access.getOrCreateBlockCacheNode(blockX, blockY, blockZ, false);
if (BlockProperties.isPassable(node.getType())) {
return true;
}
double[] bounds = access.getBounds(blockX, blockY, blockZ);
if (bounds == null) {
return true;
}
// Simplified check: Only collision of bounds of the full move is checked.
final double minX, maxX;
if (dX < 0.0) {
minX = dX * dT + oX + blockX;
maxX = oX + blockX;
}
else {
maxX = dX * dT + oX + blockX;
minX = oX + blockX;
}
final double minY, maxY;
if (dY < 0.0) {
minY = dY * dT + oY + blockY;
maxY = oY + blockY;
}
else {
maxY = dY * dT + oY + blockY;
minY = oY + blockY;
}
final double minZ, maxZ;
if (dZ < 0.0) {
minZ = dZ * dT + oZ + blockZ;
maxZ = oZ + blockZ;
}
else {
maxZ = dZ * dT + oZ + blockZ;
minZ = oZ + blockZ;
}
if (!collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, blockX, blockY, blockZ, node, null, getBlockFlags(node.getType()) | F_COLLIDE_EDGES)) {
// TODO: Might check for fence too, here.
return true;
}
// TODO: Actual ray-collision checking?
// Check for workarounds.
// TODO: check f_itchy once exists.
if (BlockProperties.isPassableWorkaround(access, blockX, blockY, blockZ, oX, oY, oZ, node, dX, dY, dZ, dT)) {
return true;
}
// Does collide (most likely).
// (Could allow start-end if passable + check first collision time or some estimate.)
return false;
}
/**
* Check passability with an arbitrary bounding box vs. a block.
*
* @param access
* the access
* @param blockX
* the block x
* @param blockY
* the block y
* @param blockZ
* the block z
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @return true, if is passable box
*/
public static final boolean isPassableBox(final BlockCache access,
final int blockX, final int blockY, final int blockZ,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ) {
// TODO: This mostly is copy and paste from isPassableRay.
final IBlockCacheNode node = access.getOrCreateBlockCacheNode(blockX, blockY, blockZ, false);
final Material id = node.getType();
if (BlockProperties.isPassable(id)) {
return true;
}
double[] bounds = access.getBounds(blockX, blockY, blockZ);
if (bounds == null) {
return true;
}
// (Coordinates are already passed in an ordered form.)
if (!collidesBlock(access, minX, minY, minZ, maxX, maxY, maxZ, blockX, blockY, blockZ, node, null, getBlockFlags(id) | F_COLLIDE_EDGES)) {
return true;
}
// Check for workarounds.
// TODO: Adapted to use the version initially intended for ray-tracing. Should have an explicit thing for the box, and let the current ray-tracing variant use that, until THEY implement something real.
// TODO: check f_itchy once exists.
if (BlockProperties.isPassableWorkaround(access, blockX, blockY, blockZ, minX - blockX, minY - blockY, minZ - blockZ, node, maxX - minX, maxY - minY, maxZ - minZ, 1.0)) {
return true;
}
// Does collide (most likely).
return false;
}
/**
* Check if the bounding box collides with a block (passable + accounting
* for workarounds).
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @return true, if is passable box
*/
public static final boolean isPassableBox(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ) {
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY);
final int iMaxY = Location.locToBlock(maxY);
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
for (int y = iMinY; y <= iMaxY; y++) {
if (!isPassableBox(access, x, y, z, minX, minY, minZ, maxX, maxY, maxZ)) {
return false;
}
}
}
}
return true;
}
/**
* Add the block coordinates that are colliding via a isPassableBox check
* for the given bounds to the given container.
*
* @param access
* the access
* @param minX
* the min x
* @param minY
* the min y
* @param minZ
* the min z
* @param maxX
* the max x
* @param maxY
* the max y
* @param maxZ
* the max z
* @param results
* the results
* @return The number of added blocks.
*/
public static final int collectInitiallyCollidingBlocks(final BlockCache access,
final double minX, final double minY, final double minZ,
final double maxX, final double maxY, final double maxZ,
final BlockPositionContainer results) {
int added = 0;
final int iMinX = Location.locToBlock(minX);
final int iMaxX = Location.locToBlock(maxX);
final int iMinY = Location.locToBlock(minY - 0.5); // Include height150 blocks.
final int iMaxY = Location.locToBlock(maxY);
final int iMinZ = Location.locToBlock(minZ);
final int iMaxZ = Location.locToBlock(maxZ);
for (int x = iMinX; x <= iMaxX; x++) {
for (int z = iMinZ; z <= iMaxZ; z++) {
for (int y = iMinY; y <= iMaxY; y++) {
if (!isPassableBox(access, x, y, z, minX, minY, minZ, maxX, maxY, maxZ)) {
results.addBlockPosition(x, y, z);
added ++;
}
}
}
}
/*
* Consider doing an xz iteration here for HEIGHT150, if y-offset <= 0.5
* (and possibly a flag is set). Note that collision behavior of fences
* can be peculiar, with barriers at 1.5 and 1.0 height (1.5 height only
* applies with non solid blocks above, thus ignore air/liquid/certain
* blocks if initially colliding with fence underneath (!)), for a
* convention.
*/
return added;
}
/**
* Test for special case activation: trap door is climbable above ladder
* with distinct facing.
*
* @return true, if is special case trap door above ladder
*/
public static boolean isSpecialCaseTrapDoorAboveLadder() {
return specialCaseTrapDoorAboveLadder;
}
/**
* Set special case activation: trap door is climbable above ladder with
* distinct facing.
*
* @param specialCaseTrapDoorAboveLadder
* the new special case trap door above ladder
*/
public static void setSpecialCaseTrapDoorAboveLadder(boolean specialCaseTrapDoorAboveLadder) {
BlockProperties.specialCaseTrapDoorAboveLadder = specialCaseTrapDoorAboveLadder;
}
}