diff --git a/docs/idabot.rst b/docs/idabot.rst index 823ceee8b686cdb0689a7d561154279aae46f4bd..569930f333b4d75ff5916fef13e902a6f7fd255d 100644 --- a/docs/idabot.rst +++ b/docs/idabot.rst @@ -1,8 +1,6 @@ IDABot ====== -.. TODO: Missing methods: on_start, on_step - .. class:: library.IDABot This is the basis of your bot. It contains all available managers and some @@ -29,6 +27,20 @@ IDABot An instance of the class :class:`library.BuildingPlacer` + Inherited methods: + + .. method:: IDABot.on_game_start(self) + + This method when Starcraft has stared, when you inherit it you have to + call the parent's on_step method in order to make it work (see + :ref:`gettingstarted`). + + .. method:: IDABot.on_step(self) + + This method is run on every tick of the game, when you inherit it you + have to call the parent's on_step method in order to make it work (see + :ref:`gettingstarted`). + Methods: .. method:: IDABot.get_all_units(self) -> List[library.Unit]