From 55d1a41bb4cfb441d1a5741f0d3b8a39bd6f8935 Mon Sep 17 00:00:00 2001
From: Emil <emil.brynielsson.jobb@gmail.com>
Date: Tue, 3 Aug 2021 14:37:29 +0200
Subject: [PATCH] added idabot.start_location, start_locations to the
documentation and updated their comments to avoid confusion
---
docs/idabot.rst | 2 ++
python-api-src/library.cpp | 4 ++--
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/idabot.rst b/docs/idabot.rst
index 301188770..8284f4534 100644
--- a/docs/idabot.rst
+++ b/docs/idabot.rst
@@ -60,6 +60,8 @@ IDABot
.. autoattribute:: current_supply
.. autoattribute:: max_supply
.. autoattribute:: current_frame
+ .. autoattribute:: start_location
+ ,, autoattribute:: start_locations
Debug
-----
diff --git a/python-api-src/library.cpp b/python-api-src/library.cpp
index 66fb17520..fdfe49e5c 100644
--- a/python-api-src/library.cpp
+++ b/python-api-src/library.cpp
@@ -114,8 +114,8 @@ PYBIND11_MODULE(library, m)
.def_property_readonly("tech_tree", &IDABot::GetTechTree, "An instance of the class :class:`library.TechTree`")
.def_property_readonly("map_tools", &IDABot::Map, "An instance of the class :class:`library.MapTools`")
.def_property_readonly("building_placer", &IDABot::GetBuildingPlacer, "An instance of the class :class:`library.BuildingPlacer`")
- .def_property_readonly("start_location", &IDABot::GetStartLocation, "CCPosition representing the start location")
- .def_property_readonly("start_locations", &IDABot::GetStartLocations, "CCPosition representing the start locations")
+ .def_property_readonly("start_location", &IDABot::GetStartLocation, "CCPosition representing the start location, note that it is the depot position that is returned.")
+ .def_property_readonly("start_locations", &IDABot::GetStartLocations, "List of CCPositions representing the start locations, note that it is the depot positions and not the center positions")
.def_property_readonly("minerals", &IDABot::GetMinerals, "How much minerals we currently have")
.def_property_readonly("current_supply", &IDABot::GetCurrentSupply, "How much supply we are currently using")
.def_property_readonly("max_supply", &IDABot::GetMaxSupply, "How much supply we can currently use")
--
GitLab