Welcome to mirror list, hosted at ThFree Co, Russian Federation.

bge.types.SCA_PythonController.rst « bge_types « rst « python_api « doc - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: a11c1398546d115b43d0bead69dc7f80f3b96d87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
SCA_PythonController(SCA_IController)
=====================================

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:: owner

      The object the controller is attached to.

      :type: :class:`KX_GameObject`

   .. 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