From 2c2c0d5edb6690a3ebbc898ff5c2b65f36248159 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Fri, 3 Aug 2018 14:23:01 +0200
Subject: [PATCH] Add inherited methods for IDABot
---
docs/idabot.rst | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/docs/idabot.rst b/docs/idabot.rst
index 823ceee8b..569930f33 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]
--
GitLab