BGE Py API
[blender.git] / source / gameengine / PyDoc / SCA_PythonController.py
1 # $Id$
2 # Documentation for SCA_PythonController
3 from SCA_IController import *
4
5 class SCA_PythonController(SCA_IController):
6         """
7         A Python controller uses a Python script to activate it's actuators,
8         based on it's sensors.
9         
10         Properties:
11         
12         @ivar script: the Python script this controller executes
13         @type script: string, read-only
14         @ivar state: the controllers state bitmask.
15                      This can be used with the GameObject's state to test if the controller is active.
16         @type state: integer
17         """
18         def activate(actuator):
19                 """
20                 Activates an actuator attached to this controller.
21                 @type actuator: actuator or the actuator name as a string
22                 """
23         def deactivate(actuator):
24                 """
25                 Deactivates an actuator attached to this controller.
26                 @type actuator: actuator or the actuator name as a string
27                 """
28                 
29         def getSensors():
30                 """
31                 Gets a list of all sensors attached to this controller.
32                 
33                 @rtype: list [L{SCA_ISensor}]
34                 """
35         def getSensor(name):
36                 """
37                 Gets the named linked sensor.
38                 
39                 @type name: string
40                 @rtype: L{SCA_ISensor}
41                 """
42         def getActuators():
43                 """
44                 Gets a list of all actuators linked to this controller.
45                 
46                 @rtype: list [L{SCA_IActuator}]
47                 """
48         def getActuator(name):
49                 """
50                 Gets the named linked actuator.
51                 
52                 @type name: string
53                 @rtype: L{SCA_IActuator}
54                 """
55         def getScript():
56                 """
57                 DEPRECATED: use the script property
58                 Gets the Python script this controller executes.
59                 
60                 @rtype: string
61                 """
62         def setScript(script):
63                 """
64                 Sets the Python script this controller executes.
65                 
66                 @type script: string.
67                 """
68         def getState():
69                 """
70                 DEPRECATED: use the state property
71                 Get the controllers state bitmask, this can be used with the GameObject's state to test if the the controller is active.
72                 This for instance will always be true however you could compare with a previous state to see when the state was activated.
73                 GameLogic.getCurrentController().getState() & GameLogic.getCurrentController().getOwner().getState()
74                 
75                 @rtype: int
76                 """
77