diff options
Diffstat (limited to 'source/gameengine/PyDoc/SCA_ActuatorSensor.py')
-rw-r--r-- | source/gameengine/PyDoc/SCA_ActuatorSensor.py | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/SCA_ActuatorSensor.py b/source/gameengine/PyDoc/SCA_ActuatorSensor.py new file mode 100644 index 00000000000..515354e8716 --- /dev/null +++ b/source/gameengine/PyDoc/SCA_ActuatorSensor.py @@ -0,0 +1,33 @@ +# $Id$ +# Documentation for SCA_ActuatorSensor +from SCA_IActuator import * +from SCA_ISensor import * +from SCA_ILogicBrick import * + +class SCA_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. + + Properties: + + @ivar actuator: the name of the actuator that the sensor is monitoring. + @type actuator: string + """ + def getActuator(): + """ + DEPRECATED: use the actuator property + Return the Actuator with which the sensor operates. + + @rtype: string + """ + def setActuator(name): + """ + DEPRECATED: use the actuator property + 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 + """ |