Module SCA_ISensor :: Class SCA_ISensor

Class SCA_ISensor

SCA_ILogicBrick.SCA_ILogicBrick --+
                                  |
                                 SCA_ISensor
Known Subclasses:

Base class for all sensor logic bricks.

Instance Methods
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors.
 
getInvert()
True if this sensor activates on negative events.
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector.
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.
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode.
 
isPositive()
True if this sensor brick is in a positive state.
 
isTriggered()
True if this sensor brick has triggered the current controller.
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings.
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors.
 
setInvert(invert)
Sets if this sensor activates on positive or negative events.
 
setLevel(level)
Set whether to detect level or edge transition when entering a state.
 
setUseNegPulseMode(pulse)
Sets negative pulse mode.
 
setUsePosPulseMode(pulse)
Sets positive pulse mode.
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.
boolean invert
Flag to set if this sensor activates on positive or negative events.
boolean level
Flag to set whether to detect level or edge transition when entering a state.
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.
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.
Method Details

getFrequency()

 

The frequency for pulse mode sensors.

Returns: integer
the pulse frequency in 1/50 sec.

getLevel()

 

Returns whether this sensor is a level detector or a edge detector. It makes a difference only in case of logic state transition (state actuator). A level detector will immediately generate a pulse, negative or positive depending on the sensor condition, as soon as the state is activated. A edge detector will wait for a state change before generating a pulse.

Returns: boolean
true if sensor is level sensitive, false if it is edge sensitive

reset()

 

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

The sensor is put in its initial state as if it was just activated.

setFrequency(freq)

 

Sets the frequency for pulse mode sensors.

Parameters:
  • freq (integer)
Returns:
the pulse frequency in 1/50 sec.

setInvert(invert)

 

Sets if this sensor activates on positive or negative events.

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

setLevel(level)

 

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

Parameters:
  • level (boolean) - Detect level instead of edge? (KX_TRUE, KX_FALSE)

setUseNegPulseMode(pulse)

 

Sets negative pulse mode.

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

setUsePosPulseMode(pulse)

 

Sets positive pulse mode.

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

Instance Variable Details

level

Flag to set whether to detect level or edge transition when entering a state. It makes a difference only in case of logic state transition (state actuator). A level detector will immediately generate a pulse, negative or positive depending on the sensor condition, as soon as the state is activated. A edge detector will wait for a state change before generating a pulse.
Type:
boolean

positive

True if this sensor brick is in a positive state. (Read only)
Type:
boolean

triggered

True if this sensor brick is in a positive state. (Read only)
Type:
boolean