Skip to content
Snippets Groups Projects

Docs for IDAReplayObserver and ReplayUnit

Merged Edvin Bergström requested to merge Doc into master
3 files
+ 136
6
Compare changes
  • Side-by-side
  • Inline
Files
3
+ 39
0
 
IDABot
 
======
 
 
.. class:: library.IDAReplayObserver
 
 
This is the basis of a replayObserver.
 
 
Inherited methods:
 
 
.. method:: IDAReplayObserver.on_game_start(self)
 
 
This method is called when a Starcraft 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:: IDABot.get_all_units(self) -> List[library.ReplayUnit]
 
 
Retrieves a list of all visible units
 
 
 
Attributes:
 
 
.. autoattribute:: minerals
 
 
Loading