Campbell Barton
7d4dc4f0f5
- changed epy_docgen.sh so inherited attributes & methods are included inline for each type, removed source option since its not useful and makes the download bigger.
34 lines
877 B
Python
34 lines
877 B
Python
# $Id$
|
|
# Documentation for KX_ActuatorSensor
|
|
from SCA_IActuator import *
|
|
from SCA_ISensor import *
|
|
from SCA_ILogicBrick 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.
|
|
|
|
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
|
|
"""
|