Gridarta Editor
Direction.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.model.direction;
21 
22 import org.jetbrains.annotations.NotNull;
23 
28 public enum Direction {
29 
33  NORTH(0, -1, 0, "North"),
34 
38  EAST(1, 0, 0, "East"),
39 
43  SOUTH(0, 1, 0, "South"),
44 
48  WEST(-1, 0, 0, "West"),
49 
53  NORTH_EAST(1, -1, 0, "NorthEast"),
54 
58  SOUTH_EAST(1, 1, 0, "SouthEast"),
59 
63  SOUTH_WEST(-1, 1, 0, "SouthWest"),
64 
68  NORTH_WEST(-1, -1, 0, "NorthWest"),
69 
73  UP(0, 0, 1, "Up"),
74 
78  DOWN(0, 0, -1, "Down");
79 
83  private final int dx;
84 
88  private final int dy;
89 
93  private final int dz;
94 
98  @NotNull
99  private final String id;
100 
108  Direction(final int dx, final int dy, final int dz, @NotNull final String id) {
109  this.dx = dx;
110  this.dy = dy;
111  this.dz = dz;
112  this.id = id;
113  }
114 
119  public int getDx() {
120  return dx;
121  }
122 
127  public int getDy() {
128  return dy;
129  }
130 
135  public int getDz() {
136  return dz;
137  }
138 
143  @NotNull
144  public String getId() {
145  return id;
146  }
147 
148 }
net.sf.gridarta.model.direction.Direction
A direction.
Definition: Direction.java:28
net.sf.gridarta.model.direction.Direction.getDx
int getDx()
Returns the relative x direction.
Definition: Direction.java:119
net.sf.gridarta.model.direction.Direction.Direction
Direction(final int dx, final int dy, final int dz, @NotNull final String id)
Creates a new instance.
Definition: Direction.java:108
net.sf.gridarta.model.direction.Direction.SOUTH
SOUTH
South.
Definition: Direction.java:43
net.sf.gridarta.model.direction.Direction.SOUTH_WEST
SOUTH_WEST
South west.
Definition: Direction.java:63
net.sf.gridarta.model.direction.Direction.NORTH
NORTH
North.
Definition: Direction.java:33
net.sf.gridarta.model.direction.Direction.NORTH_WEST
NORTH_WEST
North west.
Definition: Direction.java:68
net.sf.gridarta.model.direction.Direction.getDz
int getDz()
Returns the relative z direction.
Definition: Direction.java:135
net.sf.gridarta.model.direction.Direction.SOUTH_EAST
SOUTH_EAST
South east.
Definition: Direction.java:58
net.sf.gridarta.model.direction.Direction.DOWN
DOWN
Down.
Definition: Direction.java:78
net.sf.gridarta.model.direction.Direction.getDy
int getDy()
Returns the relative y direction.
Definition: Direction.java:127
net.sf.gridarta.model.direction.Direction.UP
UP
Up.
Definition: Direction.java:73
net.sf.gridarta.model.direction.Direction.dx
final int dx
The relative x direction.
Definition: Direction.java:83
net.sf.gridarta.model.direction.Direction.getId
String getId()
Returns the identification string.
Definition: Direction.java:144
net.sf.gridarta.model.direction.Direction.id
final String id
The identification string.
Definition: Direction.java:99
net.sf.gridarta.model.direction.Direction.EAST
EAST
East.
Definition: Direction.java:38
net.sf.gridarta.model.direction.Direction.dz
final int dz
The relative z direction.
Definition: Direction.java:93
net.sf.gridarta.model.direction.Direction.dy
final int dy
The relative y direction.
Definition: Direction.java:88
net.sf.gridarta.model.direction.Direction.NORTH_EAST
NORTH_EAST
North east.
Definition: Direction.java:53
net.sf.gridarta.model.direction.Direction.WEST
WEST
West.
Definition: Direction.java:48