com.sk89q.worldedit

Enum VectorFace

java.lang.Object

java.lang.Enum<VectorFace>

com.sk89q.worldedit.VectorFace

All Implemented Interfaces:

Serializable, Comparable<VectorFace>

public enum VectorFace
extends Enum<VectorFace>

Represents the adjacency of one vector to another. Works similarly to Bukkit's BlockFace class.

Author:

wizjany

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE_EAST
ABOVE_NORTH
ABOVE_SOUTH
ABOVE_WEST
BELOW_EAST
BELOW_NORTH
BELOW_SOUTH
BELOW_WEST
DOWN
EAST
NORTH
NORTH_EAST
NORTH_WEST
SELF
SOUTH
SOUTH_EAST
SOUTH_WEST
UP
WEST

Method Summary

Methods

Modifier and Type	Method and Description
static VectorFace	fromMods(int modX2, int modY2, int modZ2)
int	getModX()
int	getModY()
int	getModZ()
static VectorFace	valueOf(String name) Returns the enum constant of this type with the specified name.
static VectorFace[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH

public static final VectorFace NORTH

EAST

public static final VectorFace EAST

SOUTH

public static final VectorFace SOUTH

WEST

public static final VectorFace WEST

UP

public static final VectorFace UP

DOWN

public static final VectorFace DOWN

NORTH_EAST

public static final VectorFace NORTH_EAST

NORTH_WEST

public static final VectorFace NORTH_WEST

SOUTH_EAST

public static final VectorFace SOUTH_EAST

SOUTH_WEST

public static final VectorFace SOUTH_WEST

ABOVE_NORTH

public static final VectorFace ABOVE_NORTH

BELOW_NORTH

public static final VectorFace BELOW_NORTH

ABOVE_SOUTH

public static final VectorFace ABOVE_SOUTH

BELOW_SOUTH

public static final VectorFace BELOW_SOUTH

ABOVE_WEST

public static final VectorFace ABOVE_WEST

BELOW_WEST

public static final VectorFace BELOW_WEST

ABOVE_EAST

public static final VectorFace ABOVE_EAST

BELOW_EAST

public static final VectorFace BELOW_EAST

SELF

public static final VectorFace SELF

Method Detail

values

public static VectorFace[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VectorFace c : VectorFace.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VectorFace valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getModX

public int getModX()

getModZ

public int getModZ()

getModY

public int getModY()

fromMods

public static VectorFace fromMods(int modX2,
                  int modY2,
                  int modZ2)