Added Mekanism API

src/api/java/mekanism/api/Chunk3D.java

@@ -0,0 +1,118 @@
+package mekanism.api;
+
+import net.minecraft.entity.Entity;
+import net.minecraft.world.ChunkCoordIntPair;
+import net.minecraft.world.World;
+import net.minecraft.world.chunk.Chunk;
+
+/**
+ * Chunk3D - an integer-based way to keep track of and perform operations on chunks in a Minecraft-based environment. This also takes
+ * in account the dimension the chunk is in.
+ * @author aidancbrady
+ *
+ */
+public class Chunk3D
+{
+	public int dimensionId;
+
+	public int xCoord;
+	public int zCoord;
+
+	/**
+	 * Creates a Chunk3D object from the given x and z coordinates, as well as a dimension.
+	 * @param x - chunk x location
+	 * @param z - chunk z location
+	 * @param dimension - the dimension this Chunk3D is in
+	 */
+	public Chunk3D(int x, int z, int dimension)
+	{
+		xCoord = x;
+		zCoord = z;
+
+		dimensionId = dimension;
+	}
+
+	/**
+	 * Creates a Chunk3D from an entity based on it's location and dimension.
+	 * @param entity - the entity to get the Chunk3D object from
+	 */
+	public Chunk3D(Entity entity)
+	{
+		xCoord = ((int)entity.posX) >> 4;
+		zCoord = ((int)entity.posZ) >> 4;
+
+		dimensionId = entity.dimension;
+	}
+
+	/**
+	 * Creates a Chunk3D from a Coord4D based on it's coordinates and dimension.
+	 * @param coord - the Coord4D object to get this Chunk3D from
+	 */
+	public Chunk3D(Coord4D coord)
+	{
+		xCoord = coord.xCoord >> 4;
+		zCoord = coord.zCoord >> 4;
+
+		dimensionId = coord.dimensionId;
+	}
+
+	/**
+	 * Whether or not this chunk exists in the given world.
+	 * @param world - the world to check in
+	 * @return if the chunk exists
+	 */
+	public boolean exists(World world)
+	{
+		return world.getChunkProvider().chunkExists(xCoord, zCoord);
+	}
+
+	/**
+	 * Gets a Chunk object corresponding to this Chunk3D's coordinates.
+	 * @param world - the world to get the Chunk object from
+	 * @return the corresponding Chunk object
+	 */
+	public Chunk getChunk(World world)
+	{
+		return world.getChunkFromChunkCoords(xCoord, zCoord);
+	}
+
+	/**
+	 * Returns this Chunk3D in the Minecraft-based ChunkCoordIntPair format.
+	 * @return this Chunk3D as a ChunkCoordIntPair
+	 */
+	public ChunkCoordIntPair toPair()
+	{
+		return new ChunkCoordIntPair(xCoord, zCoord);
+	}
+
+	@Override
+	public Coord4D clone()
+	{
+		return new Coord4D(xCoord, zCoord, dimensionId);
+	}
+
+	@Override
+	public String toString()
+	{
+		return "[Chunk3D: " + xCoord + ", " + zCoord + ", dim=" + dimensionId + "]";
+	}
+
+	@Override
+	public boolean equals(Object obj)
+	{
+		return obj instanceof Chunk3D &&
+				((Chunk3D)obj).xCoord == xCoord &&
+				((Chunk3D)obj).zCoord == zCoord &&
+				((Chunk3D)obj).dimensionId == dimensionId;
+	}
+
+	@Override
+	public int hashCode()
+	{
+		int code = 1;
+		code = 31 * code + xCoord;
+		code = 31 * code + zCoord;
+		code = 31 * code + dimensionId;
+		return code;
+	}
+}