Add entity depth documentation.

twolivesleft · Aug 10, 2024 · 1d0a01b · 1d0a01b
1 parent 5851cab
commit 1d0a01b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/source/api/entity.rst b/docs/source/api/entity.rst
@@ -143,6 +143,10 @@ entity
 
       The number of children that this entity possesses
 
+   .. lua:attribute:: depth: integer
+
+      The depth of this entity in the hierarchy (roots have a depth of 0)
+
    .. lua:method:: index(name) [metamethod]
 
       Retrieves children with the supplied name using the property syntax (i.e. ``myEntity.theChildName``)