diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst')
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst b/doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst new file mode 100644 index 00000000000..c9d08457cc6 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst @@ -0,0 +1,29 @@ +KX_StateActuator(SCA_IActuator) +=============================== + +.. module:: bge.types + +base class --- :class:`SCA_IActuator` + +.. class:: KX_StateActuator(SCA_IActuator) + + State actuator changes the state mask of parent object. + + .. attribute:: operation + + Type of bit operation to be applied on object state mask. + + You can use one of :ref:`these constants <state-actuator-operation>` + + :type: integer + + .. attribute:: mask + + Value that defines the bits that will be modified by the operation. + + The bits that are 1 in the mask will be updated in the object state. + + The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state. + + :type: integer + |