Module GameTypes :: Class SCA_PropertySensor

Class SCA_PropertySensor

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             SCA_ISensor --+
                           |
                          SCA_PropertySensor

Activates when the game object property matches.

Properties:

Instance Methods

[hide private]

Deprecated

getType()
Gets when to activate this sensor.

source code

setType(checktype)
Set the type of check to perform.

source code

string

getProperty()
Return the property with which the sensor operates.

source code

setProperty(name)
Sets the property with which to operate.

source code

string

getValue()
Return the value with which the sensor compares to the value of the property.

source code

setValue(value)
Set the value with which the sensor operates.

source code

Inherited from SCA_ISensor

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

source code

integer

getFrequency()
The frequency for pulse mode sensors.

source code

getInvert()
True if this sensor activates on negative events.

source code

boolean

getLevel()
Returns whether this sensor is a level detector or a edge detector.

source code

getUseNegPulseMode()
True if the sensor is in negative pulse mode.

source code

getUsePosPulseMode()
True if the sensor is in positive pulse mode.

source code

isPositive()
True if this sensor brick is in a positive state.

source code

isTriggered()
True if this sensor brick has triggered the current controller.

source code

setFrequency(freq)
Sets the frequency for pulse mode sensors.

source code

setInvert(invert)
Sets if this sensor activates on positive or negative events.

source code

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

source code

setUseNegPulseMode(pulse)
Sets negative pulse mode.

source code

setUsePosPulseMode(pulse)
Sets positive pulse mode.

source code

Inherited from SCA_ILogicBrick

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

integer

mode
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)

string

propName
the property the sensor operates.

string

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

Inherited from SCA_ISensor

int

frequency
The frequency for pulse mode sensors.

boolean

invert
Flag to set if this sensor activates on positive or negative events.

boolean

level
Option whether to detect level or edge transition when entering a state.

boolean

positive
True if this sensor brick is in a positive state.

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.

boolean

triggered
True if this sensor brick is in a positive state.

boolean

useNegPulseMode
Flag to turn negative pulse mode on and off.

boolean

usePosPulseMode
Flag to turn positive pulse mode on and off.

Inherited from SCA_ILogicBrick

int

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

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

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

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

getType()

source code

Gets when to activate this sensor.

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

Deprecated: Use the mode attribute instead.

setType(checktype)

source code

Set the type of check to perform.

Deprecated: Use the mode attribute instead.

getProperty()

source code

Return the property with which the sensor operates.

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

Deprecated: Use the propName attribute instead.

setProperty(name)

source code

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

Deprecated: Use the propName attribute instead.

getValue()

source code

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.

Deprecated: Use the value attribute instead.

setValue(value)

source code

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.

Deprecated: Use the value attribute instead.