SCA_ISensor.SCA

Module SCA_ISensor :: Class SCA_ISensor

Class SCA_ISensor

SCA_ILogicBrick --+
                  |
                 SCA_ISensor

Known Subclasses:: KX_NetworkMessageSensor, KX_RaySensor, KX_TouchSensor, SCA_AlwaysSensor, SCA_KeyboardSensor, SCA_MouseSensor, SCA_PropertySensor, SCA_RandomSensor

Base class for all sensor logic bricks.

Method Summary
integer	`getFrequency()` The frequency for pulse mode sensors.
	`getInvert()` True if this sensor activates on negative events.
	`getUseNegPulseMode()` True if the sensor is in negative pulse mode.
	`getUsePosPulseMode()` True if the sensor is in positive pulse mode.
	`isPositive()` True if this sensor brick has been activated.
	`setFrequency(freq)` Sets the frequency for pulse mode sensors.
	`setInvert(invert)` Sets if this sensor activates on positive or negative events.
	`setUseNegPulseMode(pulse)` Sets negative pulse mode.
	`setUsePosPulseMode(pulse)` Sets positive pulse mode.
Inherited from SCA_ILogicBrick
integer	`getExecutePriority()` Gets the execution priority of this logic brick.
`KX_GameObject`	`getOwner()` Gets the game object associated with this logic brick.
	`setExecutePriority(priority)` Sets the priority of this logic brick.

Method Details

The frequency for pulse mode sensors.

True if this sensor activates on negative events.

True if the sensor is in negative pulse mode.

True if the sensor is in positive pulse mode.

True if this sensor brick has been activated.

Sets the frequency for pulse mode sensors.

Sets if this sensor activates on positive or negative events.

Parameters:: invert - true if activates on negative events; false if activates on positive events.
(type=boolean)

Sets negative pulse mode.

Parameters:: pulse - If True, will activate negative pulse mode for this sensor.
(type=boolean)

Sets positive pulse mode.

Parameters:: pulse - If True, will activate positive pulse mode for this sensor.
(type=boolean)

Generated by Epydoc 2.1 on Fri Aug 27 21:08:03 2004