Make color constructor set to 255 if invalid id is given

Author: JasperGeurtz

src/main/java/bwapi/Color.java

@@ -114,8 +114,7 @@ public final class Color {
             RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, new RGBQUAD(255, 255, 255)
     };
 
-    private static boolean rgbInitialized;
-    private static final byte[][][] closestColor = new byte[64][64][64];
+    private static byte[][][] closestColor = null;
 
     public final int id;
 
@@ -139,7 +138,10 @@ public Color(final int red, final int green, final int blue) {
      * @param id The index of the color in the 256-color palette.
      */
     public Color(final int id) {
-        this.id = id;
+        // The id is set to 255 if the id is invalid, as in the official BWAPI sources:
+        // https://github.com/bwapi/bwapi/blob/3438abd8e0222f37934ba62b2130c3933b067678/bwapi/include/BWAPI/Color.h#L13
+        // https://github.com/bwapi/bwapi/blob/3438abd8e0222f37934ba62b2130c3933b067678/bwapi/include/BWAPI/Type.h#L66
+        this.id = id < 0 || id > 255 ? 255 : id;
     }
 
     private static int getBestIdFor(final int red, final int green, final int blue) {
@@ -168,8 +170,8 @@ private static int getBestIdFor(final int red, final int green, final int blue)
     }
 
     private static int getRGBIndex(final int red, final int green, final int blue) {
-        if (!rgbInitialized) {
-            rgbInitialized = true;
+        if (closestColor == null) {
+            closestColor = new byte[64][64][64];
             for (int r = 0; r < 64; ++r) {
                 for (int g = 0; g < 64; ++g) {
                     for (int b = 0; b < 64; ++b) {
@@ -182,15 +184,15 @@ private static int getRGBIndex(final int red, final int green, final int blue) {
     }
 
     public int red() {
-        return id < 256 ? defaultPalette[id].rgbRed & 0xFF : 0;
+        return defaultPalette[id].rgbRed & 0xFF;
     }
 
     public int green() {
-        return id < 256 ? defaultPalette[id].rgbGreen & 0xFF : 0;
+        return defaultPalette[id].rgbGreen & 0xFF;
     }
 
     public int blue() {
-        return id < 256 ? defaultPalette[id].rgbBlue & 0xFF : 0;
+        return defaultPalette[id].rgbBlue & 0xFF;
     }
 
     @Override

src/main/java/bwapi/Player.java

@@ -25,7 +25,7 @@ public class Player implements Comparable<Player> {
     private final String name;
     private final PlayerType playerType;
     private final TilePosition startLocation;
-
+    private final Color color;
     private PlayerSelf self = null;
     PlayerSelf self() {
         if (self == null) {
@@ -41,6 +41,7 @@ PlayerSelf self() {
         this.name = playerData.getName();
         this.playerType = PlayerType.idToEnum[playerData.getType()];
         this.startLocation = new TilePosition(playerData.getStartLocationX(), playerData.getStartLocationY());
+        this.color = new Color(playerData.getColor());
     }
 
     /**
@@ -533,7 +534,7 @@ public boolean isUpgrading(final UpgradeType upgrade) {
      * @return {@link Color} object that represents the color of the current player.
      */
     public Color getColor() {
-        return new Color(playerData.getColor());
+        return color;
     }
 
     /**
@@ -543,7 +544,7 @@ public Color getColor() {
      * @return character code to use for text in Broodwar.
      */
     public Text getTextColor() {
-        switch (playerData.getColor()) {
+        switch (color.id) {
             case 111: // red
                 return Text.BrightRed;
             case 165: // blue

src/test/java/bwapi/ColorTest.java

@@ -319,6 +319,12 @@ public void checkAllColorsRGBToId() {
         assertArrayEquals(COLORS_RGB_TO_ID_BUCKETS, buckets);
     }
 
+    @Test
+    public void checkColorWithInvalidId() {
+        assertEquals(255, new Color(-1).id);
+        assertEquals(255, new Color(256).id);
+    }
+
     @Test
     public void toStringTest() {
         assertEquals("Color.Black", Color.Black.toString());

src/test/java/game/DrawTest.java

@@ -29,6 +29,10 @@ public void onFrame() {
         game.drawBoxScreen(200, 110, 350, 210, Color.Purple, true);
         game.drawTextScreen(50, 50, "%cHello %cWorld!", Text.Red, Text.Green);
 
+        Player self = game.self();
+        Player enemy = game.enemy();
+        String out = "%c"+ self.getName() + " (" + self.getRace() + ")%c vs %c" + enemy.getName() + " (" + enemy.getRace() + ")";
+        game.drawTextScreen(20, 20, out, self.getTextColor(), Text.Default, enemy.getTextColor());
     }
 
     public static void main(String[] args) {