GameTypes.SCA_ActuatorSensor

Class SCA_ActuatorSensor

PyObjectPlus --+ | CValue --+ | SCA_ILogicBrick --+ | SCA_ISensor --+ | SCA_ActuatorSensor

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:

Instance Methods

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from GameTypes.SCA_ISensor)

Deprecated

string

getActuator()
Return the Actuator with which the sensor operates.

setActuator(name)
Sets the Actuator with which to operate.

integer

getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

integer

getFrequency()
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

getInvert()
True if this sensor activates on negative events. (Inherited from GameTypes.SCA_ISensor)

boolean

getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from GameTypes.SCA_ISensor)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from GameTypes.SCA_ISensor)

isPositive()
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)

isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from GameTypes.SCA_ISensor)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)

setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)

setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from GameTypes.SCA_ISensor)

setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from GameTypes.SCA_ISensor)

Instance Variables

string

actuator
the name of the actuator that the sensor is monitoring.

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)

int

frequency
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)

bool

invalid
Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)

boolean

invert
Flag to set if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)

boolean

level
Option whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)

string

name
The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)

boolean

positive
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)

boolean

tap
When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers. (Inherited from GameTypes.SCA_ISensor)

boolean

triggered
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)

boolean

useNegPulseMode
Flag to turn negative pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)

boolean

usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)

Method Details

getActuator()

Return the Actuator with which the sensor operates.

Returns: string

Deprecated: Use the actuator attribute instead.

setActuator(name)

Sets the Actuator with which to operate. If there is no Actuator of this name, the function has no effect.

Parameters:

name (string) - actuator name

Deprecated: Use the actuator attribute instead.