Module KX_NetworkMessageSensor :: Class KX_NetworkMessageSensor

Class KX_NetworkMessageSensor

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
            SCA_ISensor.SCA_ISensor --+
                                      |
                                     KX_NetworkMessageSensor

The Message Sensor logic brick.

Currently only loopback (local) networks are supported.

Instance Methods
 
setSubjectFilterText(subject)
DEPRECATED: Use the subject property instead.
integer
getFrameMessageCount()
DEPRECATED: Use the frameMessageCount property instead.
list
getBodies()
DEPRECATED: Use the bodies property instead.
string
getSubject()
DEPRECATED: Use the subject property instead.
list
getSubjects()
DEPRECATED: Use the subjects property instead.
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)
Class Variables
int framemessageCount
Instance Variables
list of strings bodies
The list of message bodies received.
int executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
  frameMessageCount
The number of messages received since the last frame.
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 subject
The subject the sensor is looking for.
list of strings subjects
The list of message subjects received.
boolean triggered
True if this sensor brick is in a positive state. (Inherited from SCA_ISensor.SCA_ISensor)
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)
Method Details

setSubjectFilterText(subject)

 

DEPRECATED: Use the subject property instead. Change the message subject text that this sensor is listening to.

Parameters:
  • subject (string) - the new message subject to listen for.

getFrameMessageCount()

 

DEPRECATED: Use the frameMessageCount property instead. Get the number of messages received since the last frame.

Returns: integer

getBodies()

 

DEPRECATED: Use the bodies property instead. Gets the list of message bodies.

Returns: list

getSubject()

 

DEPRECATED: Use the subject property instead. Gets the message subject this sensor is listening for from the Subject: field.

Returns: string

getSubjects()

 

DEPRECATED: Use the subjects property instead. Gets the list of message subjects received.

Returns: list

Instance Variable Details

bodies

The list of message bodies received. (Read-only)
Type:
list of strings

frameMessageCount

The number of messages received since the last frame. (Read-only)

subjects

The list of message subjects received. (Read-only)
Type:
list of strings