Package com.seibel.distanthorizons.api.enums.rendering

Enum Class EDhApiHeightFogMode

java.lang.Object

java.lang.Enum<EDhApiHeightFogMode>

com.seibel.distanthorizons.api.enums.rendering.EDhApiHeightFogMode

All Implemented Interfaces:

Serializable, Comparable<EDhApiHeightFogMode>, Constable

public enum EDhApiHeightFogMode
extends Enum<EDhApiHeightFogMode>

ABOVE_CAMERA,
BELOW_CAMERA,
ABOVE_AND_BELOW_CAMERA,
ABOVE_SET_HEIGHT,
BELOW_SET_HEIGHT,
ABOVE_AND_BELOW_SET_HEIGHT,

Since:

API 2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABOVE_AND_BELOW_CAMERA
ABOVE_AND_BELOW_SET_HEIGHT
ABOVE_CAMERA
ABOVE_SET_HEIGHT
BELOW_CAMERA
BELOW_SET_HEIGHT

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	above
final boolean	basedOnCamera
final boolean	below

Method Summary

Modifier and Type	Method	Description
static EDhApiHeightFogMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EDhApiHeightFogMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ABOVE_CAMERA

public static final EDhApiHeightFogMode ABOVE_CAMERA

BELOW_CAMERA

public static final EDhApiHeightFogMode BELOW_CAMERA

ABOVE_AND_BELOW_CAMERA

public static final EDhApiHeightFogMode ABOVE_AND_BELOW_CAMERA

ABOVE_SET_HEIGHT

public static final EDhApiHeightFogMode ABOVE_SET_HEIGHT

BELOW_SET_HEIGHT

public static final EDhApiHeightFogMode BELOW_SET_HEIGHT

ABOVE_AND_BELOW_SET_HEIGHT

public static final EDhApiHeightFogMode ABOVE_AND_BELOW_SET_HEIGHT

Field Details

basedOnCamera

public final boolean basedOnCamera

above

public final boolean above

below

public final boolean below

Method Details

values

public static EDhApiHeightFogMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EDhApiHeightFogMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null