diff options
| author | Mitchell Stokes <mogurijin@gmail.com> | 2012-10-07 04:09:02 +0400 |
|---|---|---|
| committer | Mitchell Stokes <mogurijin@gmail.com> | 2012-10-07 04:09:02 +0400 |
| commit | 7beff06950a9811a9689ab2d04f8ca4d573d1436 (patch) | |
| tree | 28c1d83d556c4af2fa1adece16c15f544bcccaa4 /doc/python_api/rst/bge.types.rst | |
| parent | e7db06ad9db5a1a05b00fc835038d4366d637851 (diff) | |
BGE: Committing patch [#31442] "API improvements: Group references python api, for better control over groups and instances" by Martin Sell (moerdn). This patch adds a member and a group property to KX_GameObject:
* KX_GameObject.member returns the list of group members if the object is a group object, otherwise None is returned
* KX_GameObject.group returns the group object that the object belongs to or None if the object is not part of a group
Diffstat (limited to 'doc/python_api/rst/bge.types.rst')
| -rw-r--r-- | doc/python_api/rst/bge.types.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index f4374f7f355..6599cfeb2b2 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -986,6 +986,18 @@ Types The object's parent object. (read-only). :type: :class:`KX_GameObject` or None + + .. attribute:: members + + Returns the list of group members if the object is a group object, otherwise None is returned. + + :type: :class:`CListValue` of :class:`KX_GameObject` or None + + .. attribute:: group + + Returns the group object that the object belongs to or None if the object is not part of a group. + + :type: :class:`KX_GameObject` or None .. attribute:: visible |