Skip to content
Snippets Groups Projects
Commit 582c0b77 authored by David Bergström's avatar David Bergström
Browse files

Correct documentation regarding is_constructing

Previously it was documented as an attribute, but it is in fact method.
Describe the method, its arguments and its return value.
parent 911d46ce
No related branches found
No related tags found
No related merge requests found
...@@ -48,7 +48,6 @@ Unit ...@@ -48,7 +48,6 @@ Unit
Returns build_progress >= 1 Returns build_progress >= 1
.. autoattribute:: is_constructing
.. autoattribute:: is_flying .. autoattribute:: is_flying
.. autoattribute:: is_idle .. autoattribute:: is_idle
.. autoattribute:: is_powered .. autoattribute:: is_powered
...@@ -85,6 +84,10 @@ Unit ...@@ -85,6 +84,10 @@ Unit
Call an ability directly, different abilities has different targets. Some target the unit itself (no argument), target a point (Point2D as argument) and some target a Unit (instance of Unit as argument). Call an ability directly, different abilities has different targets. Some target the unit itself (no argument), target a point (Point2D as argument) and some target a Unit (instance of Unit as argument).
.. method:: Unit.is_constructing(self, unit_type: library.UnitType)
Returns true if the unit is currently constructing another unit of type `unit_type`. Note that `unit_type` needs to be an instance of :class:`library.UnitType`.
.. automethod:: stop .. automethod:: stop
.. automethod:: attack_unit .. automethod:: attack_unit
.. automethod:: attack_move .. automethod:: attack_move
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment