org.spongepowered.api.util

Enum RelativePositions

java.lang.Object

java.lang.Enum<RelativePositions>

org.spongepowered.api.util.RelativePositions

All Implemented Interfaces:

Serializable, Comparable<RelativePositions>

public enum RelativePositions
extends Enum<RelativePositions>

Represents the possible ways entity positions can be modified.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PITCH
X
Y
YAW
Z

Method Summary

Modifier and Type	Method and Description
static RelativePositions	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelativePositions[]	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

X

public static final RelativePositions X

Y

public static final RelativePositions Y

Z

public static final RelativePositions Z

PITCH

public static final RelativePositions PITCH

YAW

public static final RelativePositions YAW

Method Detail

values

public static RelativePositions[] 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 (RelativePositions c : RelativePositions.values())
    System.out.println(c);

Returns:

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

valueOf

public static RelativePositions 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