blender-archive/source/gameengine/PyDoc/KX_ActuatorSensor.py

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