diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst b/doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst new file mode 100644 index 00000000000..a00e9c29ad4 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst @@ -0,0 +1,48 @@ +SCA_PythonController(SCA_IController) +===================================== + +.. module:: bge.types + +base class --- :class:`SCA_IController` + +.. class:: SCA_PythonController(SCA_IController) + + A Python controller uses a Python script to activate it's actuators, + based on it's sensors. + + .. attribute:: script + + The value of this variable depends on the execution methid. + + * When 'Script' execution mode is set this value contains the entire python script as a single string (not the script name as you might expect) which can be modified to run different scripts. + * When 'Module' execution mode is set this value will contain a single line string - module name and function "module.func" or "package.modile.func" where the module names are python textblocks or external scripts. + + :type: string + + .. note:: + + Once this is set the script name given for warnings will remain unchanged. + + .. attribute:: mode + + the execution mode for this controller (read-only). + + * Script: 0, Execite the :data:`script` as a python code. + * Module: 1, Execite the :data:`script` as a module and function. + + :type: integer + + .. method:: activate(actuator) + + Activates an actuator attached to this controller. + + :arg actuator: The actuator to operate on. + :type actuator: actuator or the actuator name as a string + + .. method:: deactivate(actuator) + + Deactivates an actuator attached to this controller. + + :arg actuator: The actuator to operate on. + :type actuator: actuator or the actuator name as a string + |