Battles: add comment for deployment, reinforcement and objectives

5 files changed, 19 insertions, 1 deletions

diff --git a/core/src/ch/asynk/tankontank/game/battles/BattleCounterAttack.java b/core/src/ch/asynk/tankontank/game/battles/BattleCounterAttack.java
index 5224d59..6b93f9e 100644
--- a/core/src/ch/asynk/tankontank/game/battles/BattleCounterAttack.java
+++ b/core/src/ch/asynk/tankontank/game/battles/BattleCounterAttack.java
@@ -68,6 +68,7 @@ public class BattleCounterAttack extends BattleCommon
         if (ctrl.player.getCurrentTurn() != 5)
             return false;
 
+        // hex row 1
         Zone usEntry = new Zone(map, 9);
         usEntry.allowedMoves = (Orientation.SOUTH.s | Orientation.SOUTH_EAST.s | Orientation.SOUTH_WEST.s);
         usEntry.add(map.getHex(9, 0));
@@ -91,6 +92,7 @@ public class BattleCounterAttack extends BattleCommon
     @Override
     public void setup(Ctrl ctrl, Map map)
     {
+        // hex row 1
         Zone geExit = new Zone(map, 9);
         geExit.orientation = Orientation.NORTH;
         geExit.add(map.getHex(9, 0));
@@ -104,6 +106,7 @@ public class BattleCounterAttack extends BattleCommon
         geExit.add(map.getHex(13, 8));
         addExitZone(geExit);
 
+        // hex rows 8-9
         Zone geEntry = new Zone(map, 18);
         geEntry.orientation = Orientation.NORTH;
         for (int i = 0; i < 2; i++) {
@@ -130,6 +133,7 @@ public class BattleCounterAttack extends BattleCommon
         addReinforcement(gePlayer, geEntry, geExit, UnitId.GE_PANZER_IV);
         addReinforcement(gePlayer, geEntry, geExit, UnitId.GE_WESPE);
 
+        // hex rows 1-4
         Zone usEntry = new Zone(map, 36);
         usEntry.orientation = Orientation.SOUTH;
         for (int i = 0; i < 4; i++) {
diff --git a/core/src/ch/asynk/tankontank/game/battles/BattleFrontalAssault.java b/core/src/ch/asynk/tankontank/game/battles/BattleFrontalAssault.java
index ecd9841..be5d820 100644
--- a/core/src/ch/asynk/tankontank/game/battles/BattleFrontalAssault.java
+++ b/core/src/ch/asynk/tankontank/game/battles/BattleFrontalAssault.java
@@ -86,12 +86,14 @@ public class BattleFrontalAssault extends BattleCommon
     @Override
     public void setup(Ctrl ctrl, Map map)
     {
+        // G9, E6, H4
         objectives = new TileSet(map, 3);
         objectives.add(map.getHex(2, 2));
         objectives.add(map.getHex(6, 4));
         objectives.add(map.getHex(6, 1));
         objectives.enable(Hex.OBJECTIVE, true);
 
+        // hex rows E-H
         Zone geEntry = new Zone(map, 38);
         geEntry.orientation = Orientation.NORTH_WEST;
         for (int i = 2; i < 12; i++)
@@ -113,6 +115,7 @@ public class BattleFrontalAssault extends BattleCommon
         addReinforcement(gePlayer, geEntry, UnitId.GE_PANZER_IV);
         addReinforcement(gePlayer, geEntry, UnitId.GE_PANZER_IV);
 
+        // hex rows A-B
         Zone usEntry = new Zone(map, 19);
         usEntry.orientation = Orientation.SOUTH_EAST;
         for (int i = 4; i < 14; i++)
diff --git a/core/src/ch/asynk/tankontank/game/battles/BattleHeadToHead.java b/core/src/ch/asynk/tankontank/game/battles/BattleHeadToHead.java
index 82e4b7c..fd5c0d8 100644
--- a/core/src/ch/asynk/tankontank/game/battles/BattleHeadToHead.java
+++ b/core/src/ch/asynk/tankontank/game/battles/BattleHeadToHead.java
@@ -82,12 +82,14 @@ public class BattleHeadToHead extends BattleCommon
         usPlayer.turnEnd();
         gePlayer.turnEnd();
 
+        // B6, E6, H4
         objectives = new TileSet(map, 3);
         objectives.add(map.getHex(7, 7));
         objectives.add(map.getHex(6, 4));
         objectives.add(map.getHex(6, 1));
         objectives.enable(Hex.OBJECTIVE, true);
 
+        // southern hex row
         Zone geEntry = new Zone(map, 9);
         geEntry.allowedMoves = (Orientation.NORTH.s | Orientation.NORTH_EAST.s | Orientation.NORTH_WEST.s);
         geEntry.add(map.getHex(0, 0));
@@ -110,7 +112,7 @@ public class BattleHeadToHead extends BattleCommon
         addReinforcement(gePlayer, geEntry, UnitId.GE_PANZER_IV);
         addReinforcement(gePlayer, geEntry, UnitId.GE_PANZER_IV);
 
-
+        // northern hex row
         Zone usEntry = new Zone(map, 9);
         usEntry.allowedMoves = (Orientation.SOUTH.s | Orientation.SOUTH_EAST.s | Orientation.SOUTH_WEST.s);
         usEntry.add(map.getHex(9, 0));
diff --git a/core/src/ch/asynk/tankontank/game/battles/BattleLastStand.java b/core/src/ch/asynk/tankontank/game/battles/BattleLastStand.java
index 19ccf61..38be856 100644
--- a/core/src/ch/asynk/tankontank/game/battles/BattleLastStand.java
+++ b/core/src/ch/asynk/tankontank/game/battles/BattleLastStand.java
@@ -75,6 +75,7 @@ public class BattleLastStand extends BattleCommon
     @Override
     public void setup(Ctrl ctrl, Map map)
     {
+        // A7, E6, F6, G10
         objectives = new TileSet(map, 4);
         objectives.add(map.getHex(7, 8));
         objectives.add(map.getHex(6, 4));
@@ -82,6 +83,7 @@ public class BattleLastStand extends BattleCommon
         objectives.add(map.getHex(1, 2));
         objectives.enable(Hex.OBJECTIVE, true);
 
+        // 1 hex of E7
         Zone geEntry = new Zone(map, 7);
         geEntry.orientation = Orientation.NORTH;
         geEntry.add(map.getHex(5, 5));
@@ -97,6 +99,7 @@ public class BattleLastStand extends BattleCommon
         addReinforcement(gePlayer, geEntry, UnitId.GE_TIGER);
         addReinforcement(gePlayer, geEntry, UnitId.GE_TIGER);
 
+        // hex rows 7-10
         geEntry = new Zone(map, 32);
         geEntry.orientation = Orientation.NORTH;
         for (int i = 0; i < 4; i++) {
@@ -117,6 +120,7 @@ public class BattleLastStand extends BattleCommon
         addReinforcement(gePlayer, geEntry, UnitId.GE_PANZER_IV);
         addReinforcement(gePlayer, geEntry, UnitId.GE_WESPE);
 
+        // hex rows hex row 1 + E2 + C2
         Zone usEntry = new Zone(map, 11);
         usEntry.orientation = Orientation.SOUTH;
         usEntry.add(map.getHex(9, 0));
diff --git a/core/src/ch/asynk/tankontank/game/battles/BattleStabToTheFlank.java b/core/src/ch/asynk/tankontank/game/battles/BattleStabToTheFlank.java
index 5a39e9c..079b69c 100644
--- a/core/src/ch/asynk/tankontank/game/battles/BattleStabToTheFlank.java
+++ b/core/src/ch/asynk/tankontank/game/battles/BattleStabToTheFlank.java
@@ -81,6 +81,7 @@ public class BattleStabToTheFlank extends BattleCommon
         if (ctrl.player.getCurrentTurn() != 3)
             return false;
 
+        // hex rows I
         Zone geEntry = new Zone(map, 9);
         geEntry.allowedMoves = (Orientation.SOUTH_WEST.s | Orientation.NORTH_WEST.s);
         for (int i = 0; i < 10; i++)
@@ -95,11 +96,13 @@ public class BattleStabToTheFlank extends BattleCommon
     @Override
     public void setup(Ctrl ctrl, Map map)
     {
+        // F6, E6
         objectives = new TileSet(map, 2);
         objectives.add(map.getHex(5, 3));
         objectives.add(map.getHex(6, 4));
         objectives.enable(Hex.OBJECTIVE, true);
 
+        // hex rows D-I
         Zone geEntry = new Zone(map, 57);
         geEntry.orientation = Orientation.NORTH_WEST;
         for (int i = 3; i < 12; i++)
@@ -123,12 +126,14 @@ public class BattleStabToTheFlank extends BattleCommon
         addReinforcement(gePlayer, geEntry, UnitId.GE_AT_GUN);
         addReinforcement(gePlayer, geEntry, UnitId.GE_INFANTRY);
 
+        // hex row I
         Zone usExit = new Zone(map, 10);
         usExit.orientation = Orientation.NORTH_EAST;
         for (int i = 0; i < 10; i++)
             geEntry.add(map.getHex(i, 0));
         addExitZone(usExit);
 
+        // hex rows A-B
         Zone usEntry = new Zone(map, 19);
         usEntry.orientation = Orientation.SOUTH;
         for (int i = 4; i < 13; i++) {