source/gameengine/PyDoc/SCA_ActuatorSensor.py

   1 # $Id$
   2 # Documentation for SCA_ActuatorSensor
   3 from SCA_IActuator import *
   4 from SCA_ISensor import *
   5 from SCA_ILogicBrick import *
   6
   7 class SCA_ActuatorSensor(SCA_ISensor):
   8         """
   9         Actuator sensor detect change in actuator state of the parent object.
  10         It generates a positive pulse if the corresponding actuator is activated
  11         and a negative pulse if the actuator is deactivated.
  12
  13         Properties:
  14
  15         @ivar actuator: the name of the actuator that the sensor is monitoring.
  16         @type actuator: string
  17         """
  18         def getActuator():
  19                 """
  20                 DEPRECATED: use the actuator property
  21                 Return the Actuator with which the sensor operates.
  22
  23                 @rtype: string
  24                 """
  25         def setActuator(name):
  26                 """
  27                 DEPRECATED: use the actuator property
  28                 Sets the Actuator with which to operate. If there is no Actuator
  29                 of this name, the function has no effect.
  30
  31                 @param name: actuator name
  32                 @type name: string
  33                 """