b0e138a8009a491c0cad34290bff423b70f43d0a
[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         Properties:
13         
14         @ivar actuator: the name of the actuator that the sensor is monitoring.
15         @type actuator: string
16         """
17         def getActuator():
18                 """
19                 DEPRECATED: use the actuator property
20                 Return the Actuator with which the sensor operates.
21                 
22                 @rtype: string
23                 """
24         def setActuator(name):
25                 """
26                 DEPRECATED: use the actuator property
27                 Sets the Actuator with which to operate. If there is no Actuator
28                 of this name, the function has no effect.
29                 
30                 @param name: actuator name
31                 @type name: string
32                 """