Module GameTypes :: Class KX_NetworkMessageSensor
[frames] | no frames]

Class KX_NetworkMessageSensor

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
             SCA_ISensor --+
                           |
                          KX_NetworkMessageSensor

The Message Sensor logic brick.

Currently only loopback (local) networks are supported.

Instance Methods
bool
isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)
 
reset()
Reset sensor internal state, effect depends on the type of sensor and settings. (Inherited from GameTypes.SCA_ISensor)
    Deprecated
 
setSubjectFilterText(subject)
Change the message subject text that this sensor is listening to.
integer
getFrameMessageCount()
Get the number of messages received since the last frame.
list
getBodies()
Gets the list of message bodies.
string
getSubject()
Gets the message subject this sensor is listening for from the Subject: field.
list
getSubjects()
Gets the list of message subjects received.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)
integer
getFrequency()
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
 
getInvert()
True if this sensor activates on negative events. (Inherited from GameTypes.SCA_ISensor)
boolean
getLevel()
Returns whether this sensor is a level detector or a edge detector. (Inherited from GameTypes.SCA_ISensor)
string
getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)
 
getUseNegPulseMode()
True if the sensor is in negative pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
getUsePosPulseMode()
True if the sensor is in positive pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
isPositive()
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
 
isTriggered()
True if this sensor brick has triggered the current controller. (Inherited from GameTypes.SCA_ISensor)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)
 
setFrequency(freq)
Sets the frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
 
setInvert(invert)
Sets if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
 
setLevel(level)
Set whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
 
setUseNegPulseMode(pulse)
Sets negative pulse mode. (Inherited from GameTypes.SCA_ISensor)
 
setUsePosPulseMode(pulse)
Sets positive pulse mode. (Inherited from GameTypes.SCA_ISensor)
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 GameTypes.SCA_ILogicBrick)
int frameMessageCount
The number of messages received since the last frame.
int frequency
The frequency for pulse mode sensors. (Inherited from GameTypes.SCA_ISensor)
bool invalid
Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
boolean invert
Flag to set if this sensor activates on positive or negative events. (Inherited from GameTypes.SCA_ISensor)
boolean level
Option whether to detect level or edge transition when entering a state. (Inherited from GameTypes.SCA_ISensor)
string name
The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
boolean positive
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
string subject
The subject the sensor is looking for.
list of strings subjects
The list of message subjects received.
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. (Inherited from GameTypes.SCA_ISensor)
boolean triggered
True if this sensor brick is in a positive state. (Inherited from GameTypes.SCA_ISensor)
boolean useNegPulseMode
Flag to turn negative pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)
boolean usePosPulseMode
Flag to turn positive pulse mode on and off. (Inherited from GameTypes.SCA_ISensor)
Method Details

setSubjectFilterText(subject)

 

Change the message subject text that this sensor is listening to.

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

Deprecated: Use the subject attribute instead.

getFrameMessageCount()

 

Get the number of messages received since the last frame.

Returns: integer

Deprecated: Use the frameMessageCount attribute instead.

getBodies()

 

Gets the list of message bodies.

Returns: list

Deprecated: Use the bodies attribute instead.

getSubject()

 

Gets the message subject this sensor is listening for from the Subject: field.

Returns: string

Deprecated: Use the subject attribute instead.

getSubjects()

 

Gets the list of message subjects received.

Returns: list

Deprecated: Use the subjects attribute instead.


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)
Type:
int

subjects

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