SCA_PropertySensor.SCA_PropertySensor

Module SCA_PropertySensor :: Class SCA_PropertySensor

Class SCA_PropertySensor

SCA_ILogicBrick --+    
                  |    
        SCA_ISensor --+
                      |
                     SCA_PropertySensor

Activates when the game object property matches.

Method Summary
string	`getProperty()` Return the property with which the sensor operates.
	`getType()` Gets when to activate this sensor.
string	`getValue()` Return the value with which the sensor compares to the value of the property.
	`setProperty(name)` Sets the property with which to operate.
	`setType(checktype)` Set the type of check to perform.
	`setValue(value)` Set the value with which the sensor operates.
Inherited from SCA_ISensor
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

Return the property with which the sensor operates.

Gets when to activate this sensor.

Returns:: KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL, KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED, or KX_PROPSENSOR_EXPRESSION.

Return the value with which the sensor compares to the value of the property.

Returns:: the value of the property this sensor is watching.
(type=string)

Sets the property with which to operate. If there is no property of that name, this call is ignored.

Set the type of check to perform.

Parameters:: checktype
(type=KX_PROPSENSOR_EQUAL, KX_PROPSENSOR_NOTEQUAL, KX_PROPSENSOR_INTERVAL, KX_PROPSENSOR_CHANGED, or KX_PROPSENSOR_EXPRESSION.)

Set the value with which the sensor operates. If the value is not compatible with the type of the property, the subsequent action is ignored.

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