Module GameTypes :: Class KX_NetworkMessageSensor

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

[hide private]

Deprecated

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

source code

integer

getFrameMessageCount()
Get the number of messages received since the last frame.

source code

list

getBodies()
Gets the list of message bodies.

source code

string

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

source code

list

getSubjects()
Gets the list of message subjects received.

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]

list of strings

bodies
The list of message bodies received.

int

frameMessageCount
The number of messages received since the last frame.

string

subject
The subject the sensor is looking for.

list of strings

subjects
The list of message subjects received.

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]

setSubjectFilterText(subject)

source code

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

source code

Get the number of messages received since the last frame.

Returns: integer

Deprecated: Use the frameMessageCount attribute instead.

getBodies()

source code

Gets the list of message bodies.

Returns: list

Deprecated: Use the bodies attribute instead.

getSubject()

source code

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

Returns: string

Deprecated: Use the subject attribute instead.

getSubjects()

source code

Gets the list of message subjects received.

Returns: list

Deprecated: Use the subjects attribute instead.

Instance Variable Details

[hide private]

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