Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / SCA_PythonController.py
1 # Documentation for SCA_PythonController
2 from SCA_ILogicBrick import *
3
4 class SCA_PythonController(SCA_ILogicBrick):
5         """
6         A Python controller uses a Python script to activate it's actuators,
7         based on it's sensors.
8         """
9
10         def getSensors():
11                 """
12                 Gets a list of all sensors attached to this controller.
13                 
14                 @rtype: list [SCA_ISensor]
15                 """
16         def getSensor(name):
17                 """
18                 Gets the named linked sensor.
19                 
20                 @type name: string
21                 @rtype: SCA_ISensor
22                 """
23         def getActuators():
24                 """
25                 Gets a list of all actuators linked to this controller.
26                 
27                 @rtype: list [SCA_IActuator]
28                 """
29         def getActuator(name):
30                 """
31                 Gets the named linked actuator.
32                 
33                 @type name: string
34                 @rtype: SCA_IActuator
35                 """
36         def getScript():
37                 """
38                 Gets the Python script this controller executes.
39                 
40                 @rtype: string
41                 """
42         def setScript(script):
43                 """
44                 Sets the Python script this controller executes.
45                 
46                 @type script: string.
47                 """
48