diff --git a/docs/idabot.rst b/docs/idabot.rst index 30118877067e0824f60fe4101f73cebe16c11761..8284f4534b5800d43242e5215111f5d1b63ea7a4 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 66fb17520aeaf25c4cd33783e1808798e8d3ec47..fdfe49e5cc4da999bde93f95ec76eb0e1d38b193 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")