Module SCA_PropertySensor :: Class SCA_PropertySensor

Class SCA_PropertySensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.SCA_ISensor --+
                                      |
                                     SCA_PropertySensor

Activates when the game object property matches.

Properties:

Instance Methods
 
getType()
DEPRECATED: use the type property Gets when to activate this sensor.
 
setType(checktype)
DEPRECATED: use the type property Set the type of check to perform.
string
getProperty()
DEPRECATED: use the property property Return the property with which the sensor operates.
 
setProperty(name)
DEPRECATED: use the property property Sets the property with which to operate.
string
getValue()
DEPRECATED: use the value property Return the value with which the sensor compares to the value of the property.
 
setValue(value)
DEPRECATED: use the value property Set the value with which the sensor operates.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from SCA_ISensor.SCA_ISensor)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from SCA_ISensor.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from SCA_ISensor.SCA_ISensor)
Instance Variables
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
int frequency
The frequency for pulse mode sensors. (Inherited from SCA_ISensor.SCA_ISensor)
boolean invert
Flag to set if this sensor activates on positive or negative events. (Inherited from SCA_ISensor.SCA_ISensor)
boolean level
Flag to set whether to detect level or edge transition when entering a state. (Inherited from SCA_ISensor.SCA_ISensor)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
boolean positive
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
string property
the property with which the sensor operates.
boolean triggered
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
integer type
type of check on the property: KX_PROPSENSOR_EQUAL(1), KX_PROPSENSOR_NOTEQUAL(2), KX_PROPSENSOR_INTERVAL(3), KX_PROPSENSOR_CHANGED(4), KX_PROPSENSOR_EXPRESSION(5)
boolean useNegPulseMode
Flag to turn negative pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
boolean usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from SCA_ISensor.SCA_ISensor)
string value
the value with which the sensor compares to the value of the property.
Method Details

getType()

 

DEPRECATED: use the type property Gets when to activate this sensor.

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

setType(checktype)

 

DEPRECATED: use the type property Set the type of check to perform.

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

getProperty()

 

DEPRECATED: use the property property Return the property with which the sensor operates.

Returns: string
the name of the property this sensor is watching.

setProperty(name)

 

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

Parameters:
  • name (string.)

getValue()

 

DEPRECATED: use the value property Return the value with which the sensor compares to the value of the property.

Returns: string
the value of the property this sensor is watching.

setValue(value)

 

DEPRECATED: use the value property 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.

Parameters:
  • value (string)