Implement reading Back To Work and Patrol actions.

Author: goto-bus-stop

src/Analyzers/BodyAnalyzer.php

@@ -361,6 +361,31 @@ protected function run()
                             $this->chatMessages[] = new ChatMessage($this->currentTime, null, $message);
                         }
                         break;
+                    case self::COMMAND_PATROL:
+                        $start = $this->position - 1;
+                        $numUnits = ord($this->body[$this->position++]);
+                        $numWaypoints = ord($this->body[$this->position++]);
+                        $this->position++;
+                        $waypoints = [];
+                        // bytes for 10 waypoints are allocated. however, not
+                        // all of them are used, so we skip reading the ones
+                        // that are certainly empty.
+                        for ($i = 0; $i < $numWaypoints; $i++) {
+                            $waypoints[$i][0] = $this->readBody('f', 4);
+                        }
+                        $this->position += (10 - $numWaypoints) * 4;
+                        for ($i = 0; $i < $numWaypoints; $i++) {
+                            $waypoints[$i][1] = $this->readBody('f', 4);
+                        }
+                        $this->position += (10 - $numWaypoints) * 4;
+
+                        $this->push(new Actions\PatrolAction(
+                            $this->rec,
+                            $this->currentTime,
+                            $this->readUnits($numUnits),
+                            $waypoints
+                        ));
+                        break;
                     case self::COMMAND_FORM_FORMATION:
                         $count = ord($this->body[$this->position++]);
                         $playerId = ord($this->body[$this->position++]);
@@ -657,6 +682,15 @@ protected function run()
                             $marketId
                         ));
                         break;
+                    case self::COMMAND_GO_BACK_TO_WORK:
+                        $this->position += 3;
+                        $unitId = $this->readBody('l', 4);
+
+                        $this->push(new Actions\GoBackToWorkAction(
+                            $this->rec,
+                            $this->currentTime,
+                            $unitId
+                        ));
                     // multiplayer postgame data in UP1.4 RC2+
                     case self::COMMAND_POSTGAME:
                         $this->postGameData = $this->read(PostgameDataAnalyzer::class);

src/Model/Actions/GoBackToWorkAction.php

@@ -16,17 +16,34 @@ class GoBackToWorkAction extends Action
      */
     const ID = 0x80;
 
-    // GoBackToWork(uId=%d)
-    private $unitId;
+    /**
+     * ID of the building that should ungarrison its units and send them back
+     * to work.
+     *
+     * @var int
+     */
+    public $unitId;
 
     /**
      * Create a ...
      *
      * @param \RecAnalyst\RecordedGame  $rec  Recorded game instance.
      * @param int  $time  Recorded game instance.
      */
-    public function __construct(RecordedGame $rec, $time)
+    public function __construct(RecordedGame $rec, $time, $unitId)
     {
         parent::__construct($rec, $time);
+
+        $this->unitId = $unitId;
+    }
+
+    /**
+     * Get a string representation of the action.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('GoBackToWork(unitId=%d)', $this->unitId);
     }
 }

src/Model/Actions/PatrolAction.php

@@ -16,8 +16,19 @@ class PatrolAction extends Action
      */
     const ID = 0x15;
 
-    // Patrol(num=%d, waypoints[%d]={%s})
+    /**
+     * IDs of the units to be patrolled.
+     *
+     * @var int[]
+     */
     private $units = [];
+
+    /**
+     * Array of waypoints to pass by while patrolling. Each waypoint is a pair
+     * of coordinates [$x, $y].
+     *
+     * @var float[][]
+     */
     private $waypoints = [];
 
     /**
@@ -33,4 +44,22 @@ public function __construct(RecordedGame $rec, $time, $units, $waypoints)
         $this->units = $units;
         $this->waypoints = $waypoints;
     }
+
+    /**
+     * Get a string representation of the action.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf(
+            'Patrol(units[%d]={%s}, waypoints[%d]={%s})',
+            count($this->units),
+            implode(', ', $this->units),
+            count($this->waypoints),
+            implode(', ', array_map(function ($w) {
+                return vsprintf('{%.2f, %.2f}', $w);
+            }, $this->waypoints))
+        );
+    }
 }