blender/source/gameengine/PyDoc/SCA_ActuatorSensor.py
Campbell Barton 960fa534b7 BGE Epydocs were missing some functions
renamed KX_Light -> KX_LightObject
added some missing controllers
2009-04-06 13:13:25 +00:00

34 lines
879 B
Python

# $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
"""