cleanup epydoc errors
[blender.git] / source / gameengine / PyDoc / KX_ActuatorSensor.py
1 # $Id$
2 # Documentation for KX_ActuatorSensor
3 from SCA_IActuator import *
4 from SCA_ISensor import *
5
6 class KX_ActuatorSensor(SCA_ISensor):
7         """
8         Actuator sensor detect change in actuator state of the parent object.
9         It generates a positive pulse if the corresponding actuator is activated
10         and a negative pulse if the actuator is deactivated.
11         """
12         def getActuator():
13                 """
14                 Return the Actuator with which the sensor operates.
15                 
16                 @rtype: string
17                 """
18         def setActuator(name):
19                 """
20                 Sets the Actuator with which to operate. If there is no Actuator
21                 of this name, the function has no effect.
22                 
23                 @param name: actuator name
24                 @type name: string
25                 """