Implement Flare action.

Author: goto-bus-stop

src/Analyzers/BodyAnalyzer.php

@@ -670,6 +670,40 @@ protected function run()
                             $this->readUnits($count)
                         ));
                         break;
+                    case self::COMMAND_FLARE:
+                        $this->position += 3;
+                        // Is this always 0xFF FF FF FF?
+                        $ffffffff = $this->readBody('l', 4);
+                        $this->position += 1;
+
+                        // Whether each player can receive the flare.
+                        $visible = [];
+                        for ($i = 0; $i < 8; $i++) {
+                            $visible[$i] = ord($this->body[$this->position++]) !== 0;
+                        }
+
+                        $this->position += 3;
+
+                        // Flare location.
+                        $x = $this->readBody('f', 4);
+                        $y = $this->readBody('f', 4);
+
+                        // Multiple players have the same player number (and color)
+                        // in coop games.
+                        $playerNumber = ord($this->body[$this->position++]);
+                        // But everyone has a unique player index.
+                        $playerIndex = ord($this->body[$this->position++]);
+
+                        $this->push(new Actions\FlareAction(
+                            $this->rec,
+                            $this->currentTime,
+                            $playerNumber,
+                            $playerIndex,
+                            $x,
+                            $y,
+                            $visible
+                        ));
+                        break;
                     case self::COMMAND_UNIT_ORDER:
                         $count = ord($this->body[$this->position++]);
                         $this->position += 2;

src/Model/Actions/FlareAction.php

@@ -16,14 +16,75 @@ class FlareAction extends Action
      */
     const ID = 0x73;
 
+    /**
+     * The number of the player that sent the flare.
+     *
+     * @var int
+     */
+    public $playerNumber;
+
+    /**
+     * The index of the player that sent the flare.
+     * This can differ from the player number in coop games.
+     *
+     * @var int
+     */
+    public $playerIndex;
+
+    /**
+     * X-coordinate of the flare location.
+     *
+     * @var float
+     */
+    public $x;
+
+    /**
+     * Y-coordinate of the flare location.
+     *
+     * @var float
+     */
+    public $y;
+
+    /**
+     * Determines which player numbers can see the flare.
+     *
+     * @var bool[]
+     */
+    public $visible;
+
     /**
      * 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, $playerNumber, $playerIndex, $x, $y, $visible)
     {
         parent::__construct($rec, $time);
+
+        $this->playerNumber = $playerNumber;
+        $this->playerIndex = $playerIndex;
+        $this->x = $x;
+        $this->y = $y;
+        $this->visible = $visible;
+    }
+
+    /**
+     * Get a string representation of the action.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf(
+            'Flare(from=%d, fromIndex=%d, x=%.2f, y=%.2f, visible={%s})',
+            $this->playerNumber,
+            $this->playerIndex,
+            $this->x,
+            $this->y,
+            implode(', ', array_map(function ($visible) {
+                return $visible ? 'Y' : 'N';
+            }, $this->visible))
+        );
     }
 }