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

Enum Class EDhApiHeightFogDirection

java.lang.Object

java.lang.Enum<EDhApiHeightFogDirection>

com.seibel.distanthorizons.api.enums.rendering.EDhApiHeightFogDirection

All Implemented Interfaces:

Serializable, Comparable<EDhApiHeightFogDirection>, Constable

public enum EDhApiHeightFogDirection
extends Enum<EDhApiHeightFogDirection>

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	basedOnCamera
final boolean	fogAppliesDown
final boolean	fogAppliesUp

Method Summary

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

BELOW_CAMERA

public static final EDhApiHeightFogDirection BELOW_CAMERA

ABOVE_AND_BELOW_CAMERA

public static final EDhApiHeightFogDirection ABOVE_AND_BELOW_CAMERA

ABOVE_SET_HEIGHT

public static final EDhApiHeightFogDirection ABOVE_SET_HEIGHT

BELOW_SET_HEIGHT

public static final EDhApiHeightFogDirection BELOW_SET_HEIGHT

ABOVE_AND_BELOW_SET_HEIGHT

public static final EDhApiHeightFogDirection ABOVE_AND_BELOW_SET_HEIGHT

Field Details

basedOnCamera

public final boolean basedOnCamera

fogAppliesUp

public final boolean fogAppliesUp

fogAppliesDown

public final boolean fogAppliesDown

Method Details

values

public static EDhApiHeightFogDirection[] 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 EDhApiHeightFogDirection 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