Text (jbwapi 2.1.0 API)

java.lang.Object
- java.lang.Enum<Text>
- - bwapi.Text

All Implemented Interfaces:

Serializable, Comparable<Text>
```
public enum Text
extends Enum<Text>
```
Enum containing text formatting codes.
Such codes are used in calls to Game.drawText(bwapi.CoordinateType, int, int, java.lang.String, bwapi.Text...), Game.printf(java.lang.String, bwapi.Text...)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Text.Size
Enumeration of available text sizes.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Text.Size` Enumeration of available text sizes.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Align_Center` An alignment directive that aligns the text to the center of the screen.
`Align_Right` An alignment directive that aligns the text to the right side of the screen.
`Blue` A deep blue.
`BrightRed` A type of red.
`Brown` A dark brown.
`Cyan` A cyan color.
`DarkGreen` A dark green.
`Default` Uses the default blueish color.
`Green` A solid green.
`Grey` A dark grey.
`GreyBlue` A dark blueish color.
`GreyCyan` A different type of Cyan.
`GreyGreen` A type of Green.
`Invisible` This code hides all text and formatting that follows.
`Invisible2` This code hides all text and formatting that follows.
`LightYellow` A bright yellow.
`Orange` A solid orange.
`PlayerWhite` A dirty white.
`PlayerYellow` A deep yellow.
`Previous` Uses the previous color that was specified before the current one.
`Purple` A deep purple.
`Red` A deep red.
`Tan` A tan color.
`Teal` A teal color.
`Turquoise` A bright blue color.
`White` A bright white.
`Yellow` A solid yellow.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`formatText(String text, Text format)` Format text with a textcolor to display on broodwar
`static Text`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Text[]`	`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
  - Previous
```
public static final Text Previous
```
    Uses the previous color that was specified before the current one.
  - Default
```
public static final Text Default
```
    Uses the default blueish color. This color is used in standard game messages.
  - Yellow
```
public static final Text Yellow
```
    A solid yellow. This yellow is used in notifications and is also the default color when printing text to Broodwar.
  - White
```
public static final Text White
```
    A bright white. This is used for timers.
  - Grey
```
public static final Text Grey
```
    A dark grey. This color code will override all color formatting that follows.
  - Red
```
public static final Text Red
```
    A deep red. This color code is used for error messages.
  - Green
```
public static final Text Green
```
    A solid green. This color is used for sent messages and resource counters.
  - BrightRed
```
public static final Text BrightRed
```
    A type of red. This color is used to color the name of the red player.
  - Invisible
```
public static final Text Invisible
```
    This code hides all text and formatting that follows.
  - Blue
```
public static final Text Blue
```
    A deep blue. This color is used to color the name of the blue player.
  - Teal
```
public static final Text Teal
```
    A teal color. This color is used to color the name of the teal player.
  - Purple
```
public static final Text Purple
```
    A deep purple. This color is used to color the name of the purple player.
  - Orange
```
public static final Text Orange
```
    A solid orange. This color is used to color the name of the orange player.
  - Align_Right
```
public static final Text Align_Right
```
    An alignment directive that aligns the text to the right side of the screen.
  - Align_Center
```
public static final Text Align_Center
```
    An alignment directive that aligns the text to the center of the screen.
  - Invisible2
```
public static final Text Invisible2
```
    This code hides all text and formatting that follows.
  - Brown
```
public static final Text Brown
```
    A dark brown. This color is used to color the name of the brown player.
  - PlayerWhite
```
public static final Text PlayerWhite
```
    A dirty white. This color is used to color the name of the white player.
  - PlayerYellow
```
public static final Text PlayerYellow
```
    A deep yellow. This color is used to color the name of the yellow player.
  - DarkGreen
```
public static final Text DarkGreen
```
    A dark green. This color is used to color the name of the green player.
  - LightYellow
```
public static final Text LightYellow
```
    A bright yellow.
  - Cyan
```
public static final Text Cyan
```
    A cyan color. Similar to Default.
  - Tan
```
public static final Text Tan
```
    A tan color.
  - GreyBlue
```
public static final Text GreyBlue
```
    A dark blueish color.
  - GreyGreen
```
public static final Text GreyGreen
```
    A type of Green.
  - GreyCyan
```
public static final Text GreyCyan
```
    A different type of Cyan.
  - Turquoise
```
public static final Text Turquoise
```
    A bright blue color.
- Method Detail
  - values
```
public static Text[] 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 c : Text.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 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
  - formatText
```
public static String formatText(String text,
                                Text format)
```
    Format text with a textcolor to display on broodwar

Enum Text

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Previous

Default

Yellow

White

Grey

Red

Green

BrightRed

Invisible

Blue

Teal

Purple

Orange

Align_Right

Align_Center

Invisible2

Brown

PlayerWhite

PlayerYellow

DarkGreen

LightYellow

Cyan

Tan

GreyBlue

GreyGreen

GreyCyan

Turquoise

Method Detail

values

valueOf

formatText