Package megamek.common.board

Enum Class DeploymentElevationType

java.lang.Object

java.lang.Enum<DeploymentElevationType>

megamek.common.board.DeploymentElevationType

All Implemented Interfaces:

Serializable, Comparable<DeploymentElevationType>, Constable

public enum DeploymentElevationType
extends Enum<DeploymentElevationType>

This enum gives the meaning of an elevation or altitude that a unit can be deployed to. This is used for GUI purposes.

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
ALTITUDE
BRIDGE
BUILDING_FLOOR
BUILDING_TOP
ELEVATION
ELEVATIONS_ABOVE
ON_GROUND
ON_ICE
ON_SEAFLOOR
SUBMERGED
TERRAIN_CEILING
WATER_SURFACE

Method Summary

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

ON_GROUND

public static final DeploymentElevationType ON_GROUND

ON_ICE

public static final DeploymentElevationType ON_ICE

ON_SEAFLOOR

public static final DeploymentElevationType ON_SEAFLOOR

SUBMERGED

public static final DeploymentElevationType SUBMERGED

BUILDING_FLOOR

public static final DeploymentElevationType BUILDING_FLOOR

BUILDING_TOP

public static final DeploymentElevationType BUILDING_TOP

ELEVATION

public static final DeploymentElevationType ELEVATION

ALTITUDE

public static final DeploymentElevationType ALTITUDE

BRIDGE

public static final DeploymentElevationType BRIDGE

TERRAIN_CEILING

public static final DeploymentElevationType TERRAIN_CEILING

ELEVATIONS_ABOVE

public static final DeploymentElevationType ELEVATIONS_ABOVE

WATER_SURFACE

public static final DeploymentElevationType WATER_SURFACE

Method Details

values

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