/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion 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.
 */
package illarion.mapedit.data;

import javolution.text.TextBuilder;

import javax.annotation.Nonnull;

/**
 * Represents a single warp point, with a start point, as map coordinate and a target point as world coordinate.
 *
 * @author Tim
 */
public class MapWarpPoint {

    /**
     * The x coordinate of the target point.
     */
    private final int xTarget;
    /**
     * The y coordinate of the target point.
     */
    private final int yTarget;
    /**
     * The level/z coordinate of the target point.
     */
    private final int zTarget;

    /**
     * Creates a new Warp object with all necessary data.
     *
     * @param xTarget
     * @param yTarget
     * @param zTarget
     */
    public MapWarpPoint(int xTarget, int yTarget, int zTarget) {
        this.xTarget = xTarget;
        this.yTarget = yTarget;
        this.zTarget = zTarget;
    }

    /**
     * Copies the warp object (probably useless)
     *
     * @param old
     */
    public MapWarpPoint(@Nonnull MapWarpPoint old) {
        xTarget = old.xTarget;
        yTarget = old.yTarget;
        zTarget = old.zTarget;
    }

    /**
     * Returns the x coordinate of the target point.
     *
     * @return
     */
    public int getXTarget() {
        return xTarget;
    }

    /**
     * Returns the y coordinate of the target point.
     *
     * @return
     */
    public int getYTarget() {
        return yTarget;
    }

    /**
     * Returns the z coordinate of the target point.
     *
     * @return
     */
    public int getZTarget() {
        return zTarget;
    }

    /**
     * Serializes the current warp point to a string in the following format: <br>
     * {@code <tx>;<ty>;<tz>}
     *
     * @return
     */
    @Nonnull
    @Override
    public String toString() {
        TextBuilder builder = new TextBuilder();

        builder.append(xTarget).append(';');
        builder.append(yTarget).append(';');
        builder.append(zTarget);

        return builder.toString();
    }
}