Direction.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.model.direction;

import org.jetbrains.annotations.NotNull;

public enum Direction {

    NORTH(0, -1, 0, "North"),

    EAST(1, 0, 0, "East"),

    SOUTH(0, 1, 0, "South"),

    WEST(-1, 0, 0, "West"),

    NORTH_EAST(1, -1, 0, "NorthEast"),

    SOUTH_EAST(1, 1, 0, "SouthEast"),

    SOUTH_WEST(-1, 1, 0, "SouthWest"),

    NORTH_WEST(-1, -1, 0, "NorthWest"),

    UP(0, 0, 1, "Up"),

    DOWN(0, 0, -1, "Down");

    private final int dx;

    private final int dy;

    private final int dz;

    @NotNull
    private final String id;

    Direction(final int dx, final int dy, final int dz, @NotNull final String id) {
        this.dx = dx;
        this.dy = dy;
        this.dz = dz;
        this.id = id;
    }

    public int getDx() {
        return dx;
    }

    public int getDy() {
        return dy;
    }

    public int getDz() {
        return dz;
    }

    @NotNull
    public String getId() {
        return id;
    }

}