idareplayobserver.rst

IDAReplayObserver
=================

.. class:: library.IDAReplayObserver

   This is a class for following a replay. Se :ref:`Replays <replays>` for a example.

   Inherited methods:

   .. method:: IDAReplayObserver.on_game_start(self)

      This method is called when a replay has stared, when you inherit it you have to
      call the parent's on_game_start method in order to make it work (see
      :ref:`replays`).

   .. method:: IDAReplayObserver.on_step(self)

      This method is called on every tick of the replay, when you inherit it you
      have to call the parent's on_step method in order to make it work (see
      :ref:`replays`).

   .. method:: IDAReplayObserver.on_game_end(self)

      This method is called when the replay has ended, when you inherit it you have to
      call the parent's on_game_start method in order to make it work (see
      :ref:`replays`).

   Methods:

   .. method:: IDAReplayObserver.get_all_units(self) -> List[library.ReplayUnit]

      Retrieves a list of all visible units

   .. method:: IDAReplayObserver.get_player_race(self, player_id) -> library.Race

      Returns the players race