Module SCA_ISensor :: Class SCA_ISensor
[hide private]
[frames] | no frames]

Class SCA_ISensor

source code

SCA_ILogicBrick.SCA_ILogicBrick --+
                                  |
                                 SCA_ISensor
Known Subclasses:

Base class for all sensor logic bricks.

Instance Methods [hide private]
 
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
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode.
source code
 
setUsePosPulseMode(pulse)
Sets positive pulse mode.
source code
integer
getFrequency()
The frequency for pulse mode sensors.
source code
 
setFrequency(freq)
Sets the frequency for pulse mode sensors.
source code
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode.
source code
 
setUseNegPulseMode(pulse)
Sets negative pulse mode.
source code
 
getInvert()
True if this sensor activates on negative events.
source code
 
setInvert(invert)
Sets if this sensor activates on positive or negative events.
source code
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector.
source code
 
setLevel(level)
Set whether to detect level or edge transition when entering a state.
source code
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings.
source code

Inherited from SCA_ILogicBrick.SCA_ILogicBrick: getExecutePriority, getOwner, setExecutePriority

Method Details [hide private]

setUsePosPulseMode(pulse)

source code 

Sets positive pulse mode.

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

getFrequency()

source code 

The frequency for pulse mode sensors.

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

setFrequency(freq)

source code 

Sets the frequency for pulse mode sensors.

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

setUseNegPulseMode(pulse)

source code 

Sets negative pulse mode.

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

setInvert(invert)

source code 

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.

getLevel()

source code 

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

setLevel(level)

source code 

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

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

reset()

source code 

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.