Color (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.Color

```
public final class Color
extends Object
```
The Color object is used in drawing routines to specify the color to use.
Starcraft uses a 256 color palette for rendering. Thus, the colors available are limited to this palette.

Field Summary

Fields
Modifier and Type	Field and Description
`static Color`	`Black` The color black.
`static Color`	`Blue` The default color for Player 2.
`static Color`	`Brown` The default color for Player 6.
`static Color`	`Cyan` The default color for Neutral (Player 12).
`static Color`	`Green` The alternate color for Player 7 on Ice tilesets.
`static Color`	`Grey` The color grey.
`int`	`id`
`static Color`	`Orange` The default color for Player 5.
`static Color`	`Purple` The default color for Player 4.
`static Color`	`Red` The default color for Player 1.
`static Color`	`Teal` The default color for Player 3.
`static Color`	`White` A bright white.
`static Color`	`Yellow` The default color for Player 8.

Constructor Summary

Constructors
Constructor and Description
`Color(int id)` A constructor that uses the color at the specified palette index.
`Color(int red, int green, int blue)` A constructor that uses the color index in the palette that is closest to the given rgb values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`blue()`
`boolean`	`equals(Object o)`
`int`	`green()`
`int`	`hashCode()`
`int`	`red()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - Red
```
public static final Color Red
```
    The default color for Player 1.
  - Blue
```
public static final Color Blue
```
    The default color for Player 2.
  - Teal
```
public static final Color Teal
```
    The default color for Player 3.
  - Purple
```
public static final Color Purple
```
    The default color for Player 4.
  - Orange
```
public static final Color Orange
```
    The default color for Player 5.
  - Brown
```
public static final Color Brown
```
    The default color for Player 6.
  - White
```
public static final Color White
```
    A bright white. Note that this is lighter than Player 7's white.
  - Yellow
```
public static final Color Yellow
```
    The default color for Player 8.
  - Green
```
public static final Color Green
```
    The alternate color for Player 7 on Ice tilesets.
  - Cyan
```
public static final Color Cyan
```
    The default color for Neutral (Player 12).
  - Black
```
public static final Color Black
```
    The color black.
  - Grey
```
public static final Color Grey
```
    The color grey.
  - id
```
public final int id
```
- Constructor Detail
  - Color
```
public Color(int red,
             int green,
             int blue)
```
    A constructor that uses the color index in the palette that is closest to the given rgb values. On its first call, the colors in the palette will be sorted for fast indexing.
    This function computes the distance of the RGB values and may not be accurate.
    
    Parameters:
    
    red - The amount of red.
    
    green - The amount of green.
    
    blue - The amount of blue.
  - Color
```
public Color(int id)
```
    A constructor that uses the color at the specified palette index.
    
    Parameters:
    
    id - The index of the color in the 256-color palette.
- Method Detail
  - red
```
public int red()
```
  - green
```
public int green()
```
  - blue
```
public int blue()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Color

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Red

Blue

Teal

Purple

Orange

Brown

White

Yellow

Green

Cyan

Black

Grey

id

Constructor Detail

Color

Color

Method Detail

red

green

blue

equals

hashCode

toString