From 4a709fb85ee896c79a80770aa45d99143b017d0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <david.bergstrom@liu.se> Date: Tue, 20 Aug 2019 16:28:22 +0200 Subject: [PATCH] Add documentation for merge request !5 https://gitlab.ida.liu.se/course-starcraft-ai/pycommandcenter/merge_requests/5 --- docs/unit.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/unit.rst b/docs/unit.rst index da1648adc..88e0f527e 100644 --- a/docs/unit.rst +++ b/docs/unit.rst @@ -26,6 +26,10 @@ Unit .. autoattribute:: build_percentage .. autoattribute:: energy + .. autoattribute:: facing + + Returns the direction the unit is facing + .. autoattribute:: hit_points .. autoattribute:: max_hit_points .. autoattribute:: id @@ -56,6 +60,16 @@ Unit See :ref:`playerconstants` for more information. .. autoattribute:: position + .. autoattribute:: current_ability_id + + .. autoattribute:: progress + + Returns the progress of currently used ability (-1 if not using ability) + + .. autoattribute:: radius + + Retruns the radius of the unit + .. autoattribute:: shields .. autoattribute:: tile_position .. autoattribute:: unit_type @@ -89,3 +103,7 @@ Unit Returns True if the target has a valid target and False otherwise. + .. automethod:: hold_position + .. automethod:: stop_dance + + Stop and dance -- GitLab