diff options
Diffstat (limited to 'source/gameengine/PyDoc/KX_ActuatorSensor.py')
-rw-r--r-- | source/gameengine/PyDoc/KX_ActuatorSensor.py | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/KX_ActuatorSensor.py b/source/gameengine/PyDoc/KX_ActuatorSensor.py new file mode 100644 index 00000000000..cdfbf27576e --- /dev/null +++ b/source/gameengine/PyDoc/KX_ActuatorSensor.py @@ -0,0 +1,25 @@ +# $Id$ +# Documentation for KX_ActuatorSensor +from SCA_IActuator import * +from SCA_ISensor import * + +class KX_ActuatorSensor(SCA_ISensor): + """ + Actuator sensor detect change in actuator state of the parent object. + It generates a positive pulse if the corresponding actuator is activated + and a negative pulse if the actuator is deactivated. + """ + def getActuator(): + """ + Return the Actuator with which the sensor operates. + + @rtype: string + """ + def setActuator(name): + """ + Sets the Actuator with which to operate. If there is no Actuator + of this name, the function has no effect. + + @param name: actuator name + @type name: string + """ |