diff --git a/docs/helpers.rst b/docs/helpers.rst index 06b7c1c215afc04da3247f1ac361031f5c60b670..6f2cc8e924e2a7e62c8d37ae75a591a7dfb3ac56 100644 --- a/docs/helpers.rst +++ b/docs/helpers.rst @@ -109,6 +109,43 @@ MapTools :members: :undoc-members: + This class contains two types of methods: + + * Methods for drawing information to the screen + * Methods for extracting information about the map + + First, let us look at the method concerning drawing information to the + screen. Methods with the suffix ``_screen`` takes percentages of the + screens height and width, i.e. values between 0 and 1. Methods without + this suffix uses the same coordinate system as the game, i.e. world + coordinates. + + .. automethod:: draw_box + .. automethod:: draw_circle + .. automethod:: draw_line + .. automethod:: draw_text + .. automethod:: draw_text_screen + + These are methods which are useful for extracting information about the + game map: + + .. automethod:: can_build_type_at_position + .. automethod:: get_closest_tiles_to + .. automethod:: get_distance_map + .. automethod:: get_ground_distance + .. automethod:: get_least_recently_seen_tile + .. autoattribute:: height + .. autoattribute:: width + .. automethod:: is_buildable + .. automethod:: is_connected + .. automethod:: is_depot_buildable_tile + .. automethod:: is_explored + .. automethod:: is_powered + .. automethod:: is_valid_position + .. automethod:: is_valid_tile + .. automethod:: is_visible + .. automethod:: is_walkable + Color ~~~~~