Package megamek.common.units

Enum Class PlatoonType

java.lang.Object

java.lang.Enum<PlatoonType>

megamek.common.units.PlatoonType

All Implemented Interfaces:

Serializable, Comparable<PlatoonType>, Constable

public enum PlatoonType
extends Enum<PlatoonType>

The amount of space taken up by an infantry unit in a transport bay differs from the space in an infantry compartment (used in APCs) due to quarters, equipment storage, and maintenance equipment. A single cubicle holds a platoon, except in the case of mechanized which requires a cubicle per squad.

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
FOOT
JUMP
MECHANIZED
MOTORIZED

Method Summary

Modifier and Type	Method	Description
int	getClanPersonnel()
int	getISPersonnel()
static PlatoonType	getPlatoonType(Entity en)
int	getWeight()
String	toString()
static PlatoonType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlatoonType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FOOT

public static final PlatoonType FOOT

JUMP

public static final PlatoonType JUMP

MOTORIZED

public static final PlatoonType MOTORIZED

MECHANIZED

public static final PlatoonType MECHANIZED

Method Details

values

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

getWeight

public int getWeight()

getISPersonnel

public int getISPersonnel()

getClanPersonnel

public int getClanPersonnel()

toString

public String toString()

Overrides:

toString in class Enum<PlatoonType>

getPlatoonType

public static PlatoonType getPlatoonType(Entity en)