Merge remote-tracking branch 'origin/develop' into develop

Author: bytekeeper

README.md

@@ -1,11 +1,12 @@
 [![Build Status](https://travis-ci.org/JavaBWAPI/JBWAPI.svg?branch=develop)](https://travis-ci.org/JavaBWAPI/JBWAPI)
 # JBWAPI
-Pure Java [bwapi](https://github.com/bwapi/bwapi) client (4.2.0) implementation backed by [N00byEdge](https://github.com/N00byEdge)'s [JavaBWAPIBackend](https://github.com/N00byEdge/JavaBWAPIBackend) idea and automated by [Bytekeeper](https://github.com/Bytekeeper).
+Pure Java [bwapi](https://github.com/bwapi/bwapi) client (4.2.0 & 4.4.0) implementation backed by [N00byEdge](https://github.com/N00byEdge)'s [JavaBWAPIBackend](https://github.com/N00byEdge/JavaBWAPIBackend) idea and automated by [Bytekeeper](https://github.com/Bytekeeper).
 
 Also contains the pure Java BWEM implementation from [BWAPI4J](https://github.com/OpenBW/BWAPI4J).
 
 ## goals
-Have a similar (Java) interface to BWMirror to make porting BWMirror bots easy without all the DLL and JNI hassle and overhead.
+ - Have a similar (Java) interface to BWMirror to make porting BWMirror bots easy without all the DLL and JNI hassle and overhead.
+ - Stay as updated as possible with the BWAPI releases
 
 ## advantages
  - no dependency on external DLL's
@@ -35,7 +36,7 @@ Add JBWAPI as a dependecy
 <dependency>
     <groupId>com.github.JavaBWAPI</groupId>
     <artifactId>JBWAPI</artifactId>
-    <version>0.5</version>
+    <version>0.6</version>
 </dependency>
 ```
 
@@ -53,7 +54,7 @@ allprojects {
 Add JBWAPI as a dependecy
 ```
 dependencies {
-    implementation 'com.github.JavaBWAPI:JBWAPI:0.5'
+    implementation 'com.github.JavaBWAPI:JBWAPI:0.6'
 }
 ```
 
@@ -67,3 +68,7 @@ Alternatively add the latest .jar from the [releases](https://github.com/JavaBWA
 or if you already have maven installed
 
 `mvn package`
+
+## tutorial
+
+If you are a just starting out with bot development, it might be helpful to follow the [tutorial](https://github.com/JavaBWAPI/Java-BWAPI-Tutorial/wiki)!

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>jbwapi</groupId>
     <artifactId>jbwapi</artifactId>
-    <version>0.5</version>
+    <version>0.6</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/bwapi/BuildingPlacer.java

@@ -447,11 +447,11 @@ boolean hasValidSpace() {
         }
 
         void backup() {
-            System.arraycopy(save, 0, data, 0, save.length);
+            System.arraycopy(data, 0, save, 0, data.length);
         }
 
         void restore() {
-            System.arraycopy(data, 0, save, 0, data.length);
+            System.arraycopy(save, 0, data, 0, save.length);
         }
 
         void restoreIfInvalid() {

src/main/java/bwapi/Client.java

@@ -35,14 +35,17 @@ of this software and associated documentation files (the "Software"), to deal
 import java.io.RandomAccessFile;
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
+import java.util.Arrays;
+import java.util.List;
 
 class Client {
     private static final int READ_WRITE = 0x1 | 0x2 | 0x4;
     private static final int GAME_SIZE = 4 // ServerProcID
             + 4 // IsConnected
             + 4 // LastKeepAliveTime
             ;
-    private static final int BWAPI_VERSION = 10002;
+    private static final List<Integer> SUPPORTED_BWAPI_VERSIONS = Arrays.asList(10002, 10003);
+    private static final int MAX_COUNT = 19999;
 
     private static final int maxNumGames = 8;
     private static final int gameTableSize = GAME_SIZE * maxNumGames;
@@ -86,8 +89,8 @@ private void connect(final int procID) throws Exception {
         data = new ClientData(sharedMemory).new GameData(0);
 
         final int clientVersion = data.getClient_version();
-        if (clientVersion != BWAPI_VERSION) {
-            throw new Exception("BWAPI version mismatch, expected: " + BWAPI_VERSION + ", got: " + clientVersion);
+        if (!SUPPORTED_BWAPI_VERSIONS.contains(clientVersion)) {
+            throw new Exception("BWAPI version mismatch, expected one of: " + SUPPORTED_BWAPI_VERSIONS + ", got: " + clientVersion);
         }
 
         System.out.println("Connected to BWAPI@" + procID + " with version " + clientVersion + ": " + data.getRevision());
@@ -115,35 +118,35 @@ public interface EventHandler {
     }
 
 
-    public String eventString(final int s) {
+    String eventString(final int s) {
         return data.getEventStrings(s);
     }
 
-    public int addString(final String s) {
+    int addString(final String s) {
         int stringCount = data.getStringCount();
-        if (stringCount >= 19999) throw new IllegalStateException("Too many shapes!");
+        if (stringCount >= MAX_COUNT) throw new IllegalStateException("Too many shapes!");
         data.setStringCount(stringCount + 1);
         data.setStrings(stringCount, s);
         return stringCount;
     }
 
-    public Shape addShape() {
+    Shape addShape() {
         int shapeCount = data.getShapeCount();
-        if (shapeCount >= 19999) throw new IllegalStateException("Too many shapes!");
+        if (shapeCount >= MAX_COUNT) throw new IllegalStateException("Too many shapes!");
         data.setShapeCount(shapeCount + 1);
         return data.getShapes(shapeCount);
     }
 
-    public Command addCommand() {
+    Command addCommand() {
         final int commandCount = data.getCommandCount();
-        if (commandCount >= 19999) throw new IllegalStateException("Too many commands!");
+        if (commandCount >= MAX_COUNT) throw new IllegalStateException("Too many commands!");
         data.setCommandCount(commandCount + 1);
         return data.getCommands(commandCount);
     }
 
-    public ClientData.UnitCommand addUnitCommand() {
+    ClientData.UnitCommand addUnitCommand() {
         int unitCommandCount = data.getUnitCommandCount();
-        if (unitCommandCount >= 19999) throw new IllegalStateException("Too many unit commands!");
+        if (unitCommandCount >= MAX_COUNT) throw new IllegalStateException("Too many unit commands!");
         data.setUnitCommandCount(unitCommandCount + 1);
         return data.getUnitCommands(unitCommandCount);
     }

src/main/java/bwapi/Force.java

@@ -1,7 +1,8 @@
 package bwapi;
 
 import bwapi.ClientData.ForceData;
-import java.util.Set;
+
+import java.util.List;
 import java.util.stream.Collectors;
 
 public class Force {
@@ -24,10 +25,10 @@ public String getName() {
         return name;
     }
 
-    public Set<Player> getPlayers() {
+    public List<Player> getPlayers() {
         return game.getPlayers().stream()
                 .filter(p -> equals(p.getForce()))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
     }
 
     public boolean equals(final Object that) {

src/main/java/bwapi/Game.java

@@ -365,7 +365,7 @@ public Player getPlayer(final int playerID) {
     }
 
     public Unit getUnit(final int unitID) {
-        if (unitID < 0) {
+        if (unitID < 0 || unitID >= units.length) {
             return null;
         }
         return units[unitID];

src/main/java/bwapi/Player.java

@@ -1,7 +1,8 @@
 package bwapi;
 
 import bwapi.ClientData.PlayerData;
-import java.util.Set;
+
+import java.util.List;
 import java.util.stream.Collectors;
 
 import static bwapi.UnitType.*;
@@ -37,10 +38,10 @@ public String getName() {
         return name;
     }
 
-    public Set<Unit> getUnits() {
+    public List<Unit> getUnits() {
         return game.getAllUnits().stream()
                 .filter(u -> equals(u.getPlayer()))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
     }
 
     public Race getRace() {

src/main/java/bwapi/Unit.java

@@ -435,13 +435,13 @@ public Unit getTransport() {
         return game.getUnit(unitData.getTransport());
     }
 
-    public Set<Unit> getLoadedUnits() {
+    public List<Unit> getLoadedUnits() {
         if (getType().spaceProvided() < 1) {
-            return new HashSet<>();
+            return new ArrayList<>();
         }
         return game.getAllUnits().stream()
                 .filter(u -> equals(u.getTransport()))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
     }
 
     public int getSpaceRemaining() {
@@ -458,26 +458,26 @@ public Unit getCarrier() {
         return game.getUnit(unitData.getCarrier());
     }
 
-    public Set<Unit> getInterceptors() {
+    public List<Unit> getInterceptors() {
         if (getType() != Protoss_Carrier && getType() != Hero_Gantrithor) {
-            return new HashSet<>();
+            return new ArrayList<>();
         }
         return game.getAllUnits().stream()
                 .filter(u -> equals(u.getCarrier()))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
     }
 
     public Unit getHatchery() {
         return game.getUnit(unitData.getHatchery());
     }
 
-    public Set<Unit> getLarva() {
+    public List<Unit> getLarva() {
         if (!getType().producesLarva()) {
-            return new HashSet<>();
+            return new ArrayList<>();
         }
         return game.getAllUnits().stream()
                 .filter(u -> equals(u.getHatchery()))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
     }
 
     public List<Unit> getUnitsInRadius(final int radius) {

src/main/java/bwem/unit/NeutralImpl.java

@@ -104,7 +104,9 @@ public void setBlocking(final List<WalkPosition> blockedAreas) {
     public List<Area> getBlockedAreas() {
         final List<Area> blockedAreas = new ArrayList<>();
         for (final WalkPosition w : this.blockedAreas) {
-            blockedAreas.add(getMap().getArea(w));
+            if (getMap().getArea(w) != null) {
+                blockedAreas.add(getMap().getArea(w));
+            }
         }
         return blockedAreas;
     }
@@ -200,21 +202,23 @@ private void removeFromTiles() {
                     }
                 } else {
                     Neutral prevStacked = tile.getNeutral();
-                    while (!prevStacked.getNextStacked().equals(this)) {
+                    while (prevStacked != null && !this.equals(prevStacked.getNextStacked())) {
                         prevStacked = prevStacked.getNextStacked();
                     }
-                    if (!((NeutralImpl) prevStacked).isSameUnitTypeAs(this)) {
-                        //                    bwem_assert(pPrevStacked->Type() == Type());
-                        throw new IllegalStateException();
-                    } else if (!(prevStacked.getTopLeft().equals(getTopLeft()))) {
-                        //                    bwem_assert(pPrevStacked->topLeft() == topLeft());
-                        throw new IllegalStateException();
-                    } else if (!(dx == 0 && dy == 0)) {
+                    if (!(dx == 0 && dy == 0)) {
                         //                    bwem_assert((dx == 0) && (dy == 0));
                         throw new IllegalStateException();
                     }
-
-                    ((NeutralImpl) prevStacked).nextStacked = nextStacked;
+                    if (prevStacked != null) {
+                        if (!((NeutralImpl) prevStacked).isSameUnitTypeAs(this)) {
+                            //                    bwem_assert(pPrevStacked->Type() == Type());
+                            throw new IllegalStateException();
+                        } else if (!(prevStacked.getTopLeft().equals(getTopLeft()))) {
+                            //                    bwem_assert(pPrevStacked->topLeft() == topLeft());
+                            throw new IllegalStateException();
+                        }
+                        ((NeutralImpl) prevStacked).nextStacked = nextStacked;
+                    }
                     this.nextStacked = null;
                     return;
                 }