bwapi

Enum UnitSizeType

java.lang.Object

java.lang.Enum<UnitSizeType>

bwapi.UnitSizeType

All Implemented Interfaces:

Serializable, Comparable<UnitSizeType>

public enum UnitSizeType
extends Enum<UnitSizeType>

Size types are used by unit types in Broodwar to determine how much damage will be applied.

This corresponds with DamageType for several different damage reduction applications.

See Also:

DamageType, UnitType,

[View on Starcraft Campendium (Official Website)](http://classic.battle.net/scc/gs/damage.shtml)


Enum Constant Summary

Enum Constants

Enum Constant and Description
Independent
Large
Medium
None
Small
Unknown

Method Summary

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

Independent

public static final UnitSizeType Independent

Small

public static final UnitSizeType Small

Medium

public static final UnitSizeType Medium

Large

public static final UnitSizeType Large

None

public static final UnitSizeType None

Unknown

public static final UnitSizeType Unknown

Method Detail

values

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

Returns:

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

valueOf

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