bwapi

Enum Text.Size

java.lang.Object

java.lang.Enum<Text.Size>

bwapi.Text.Size

All Implemented Interfaces:

Serializable, Comparable<Text.Size>

Enclosing class:

Text

public static enum Text.Size
extends Enum<Text.Size>

Enumeration of available text sizes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Default The standard text size, used for most things in the game such as chat messages.
Huge The largest text size in the game.
Large A larger text size.
Small The smallest text size in the game.

Method Summary

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

Small

public static final Text.Size Small

The smallest text size in the game.

Default

public static final Text.Size Default

The standard text size, used for most things in the game such as chat messages.

Large

public static final Text.Size Large

A larger text size. This size is used for the in-game countdown timer seen in @CTF and @UMS game types.

Huge

public static final Text.Size Huge

The largest text size in the game.

Method Detail

values

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

Returns:

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

valueOf

public static Text.Size 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