diff options
author | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-05-04 07:04:09 +0300 |
---|---|---|
committer | Sybren A. Stüvel <sybren@stuvel.eu> | 2015-05-04 07:04:09 +0300 |
commit | 4e7ef3f5cd8cd96545c3250a93bf856174ee54e2 (patch) | |
tree | 871c7817cf02fd9974263e75efa9fff4691515c6 /doc/python_api | |
parent | 62b13c6d070ac5be86c6ff64cb2b32066f64a0db (diff) |
BGE: Added 'ghost' arg to KX_GameObject.suspendDynamics() method
The implementation of this 'ghost' argument already existed in the C++
source, but wasn't exposed to Python yet.
Diffstat (limited to 'doc/python_api')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst index 7b2f68b019c..672df3728a9 100644 --- a/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst +++ b/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst @@ -84,6 +84,8 @@ base class --- :class:`SCA_IObject` :type: boolean + .. seealso:: :py:meth:`suspendDynamics` and :py:meth:`restoreDynamics` allow you to change the state. + .. attribute:: linearDamping The object's linear damping, also known as translational damping. Can be set simultaneously with angular damping using the :py:meth:`setDamping` method. @@ -671,13 +673,19 @@ base class --- :class:`SCA_IObject` :arg angular_damping: Angular ("rotational") damping factor. :type angular_damping: float ∈ [0, 1] - .. method:: suspendDynamics() + .. method:: suspendDynamics([ghost]) Suspends physics for this object. + :arg ghost: When set to `True`, collisions with the object will be ignored, similar to the "ghost" checkbox in + Blender. When `False` (the default), the object becomes static but still collide with other objects. + :type ghost: bool + + .. seealso:: :py:attr:`isSuspendDynamics` allows you to inspect whether the object is in a suspended state. + .. method:: restoreDynamics() - Resumes physics for this object. + Resumes physics for this object. Also reinstates collisions; the object will no longer be a ghost. .. note:: |