WarpPoint.java

/**
    Copyright (C) <2015> <coolAlias>

    This file is part of coolAlias' Zelda Sword Skills Minecraft Mod; as such,
    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 zeldaswordskills.util;

import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.util.BlockPos;
import net.minecraftforge.common.util.Constants;

/**
 * 
 * Simple utility class to store all data needed to teleport somewhere
 *
 */
public class WarpPoint
{
	/** Warp dimension */
	public final int dimensionId;

	/** Warp coordinates */
	public final BlockPos pos;

	public WarpPoint(int dimensionId, BlockPos pos) {
		this.dimensionId = dimensionId;
		this.pos = pos;
	}

	@Override
	public String toString() {
		return String.format("[%d/%d/%d in dimension %d]", pos.getX(), pos.getY(), pos.getZ(), dimensionId);
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + dimensionId;
		result = prime * result + pos.getX();
		result = prime * result + pos.getY();
		result = prime * result + pos.getZ();
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		} else if (obj == null || getClass() != obj.getClass()) {
			return false;
		}
		WarpPoint other = (WarpPoint) obj;
		return (dimensionId == other.dimensionId && pos.getX() == other.pos.getX() && pos.getY() == other.pos.getY() && pos.getZ() == other.pos.getZ());
	}

	/**
	 * Attempts to create a Warp Point from a string
	 * @param string Expected format is that of {@link WarpPoint#convertToString()}: "[dimension_id, x, y, z]" where each value is an integer, e.g. "[0, 100, 64, 100]"
	 * @return Either a valid WarpPoint or null
	 */
	public static WarpPoint convertFromString(String string) {
		if (string.length() < 9 || !string.startsWith("[") || !string.endsWith("]")) {
			return null;
		}
		string = string.substring(1, string.length() - 1);
		String[] pieces = string.split(",");
		if (pieces.length != 4) {
			return null;
		}
		try {
			return new WarpPoint(Integer.parseInt(pieces[0]), new BlockPos(Integer.parseInt(pieces[1]), Integer.parseInt(pieces[2]), Integer.parseInt(pieces[3])));
		} catch (NumberFormatException e) {
			// do nothing
		}
		return null;
	}

	/**
	 * Returns the WarpPoint as a string in the format '[dimension_id, x, y, z]' suitable for passing to {@link WarpPoint#convertFromString(String)}
	 */
	public String convertToString() {
		return String.format("[%d,%d,%d,%d]", dimensionId, pos.getX(), pos.getY(), pos.getZ());
	}

	/**
	 * Returns an NBTTagCompound containing this warp point
	 */
	public NBTTagCompound writeToNBT() {
		NBTTagCompound tag = new NBTTagCompound();
		tag.setIntArray("WarpPointData", new int[]{dimensionId, pos.getX(), pos.getY(), pos.getZ()});
		return tag;
	}

	/**
	 * Creates a new warp point from the NBTTagCompound
	 * @param tag	Must be the same tag format as returned by {@link #writeToNBT()} 
	 */
	public static WarpPoint readFromNBT(NBTTagCompound tag) {
		if (tag.hasKey("WarpPointData") && tag.getTag("WarpPointData").getId() == Constants.NBT.TAG_INT_ARRAY) {
			int[] data = tag.getIntArray("WarpPointData");
			return new WarpPoint(data[0], new BlockPos(data[1], data[2], data[3]));
		}
		return null;
	}
}