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

Class KX_NetworkMessageSensor

SCA_ILogicBrick --+    
                  |    
        SCA_ISensor --+
                      |
                     KX_NetworkMessageSensor


The Message Sensor logic brick.

Currently only loopback (local) networks are supported.
Method Summary
list getBodies()
Gets the list of message bodies.
integer getFrameMessageCount()
Get the number of messages received since the last frame.
string getSubject()
Gets the message subject this sensor is listening for from the Subject: field.
list getSubjects()
Gets the list of message subjects received.
  setSubjectFilterText(subject)
Change the message subject text that this sensor is listening to.
    Inherited from SCA_ISensor
integer getFrequency()
The frequency for pulse mode sensors.
  getInvert()
True if this sensor activates on negative events.
  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 has been activated.
  setFrequency(freq)
Sets the frequency for pulse mode sensors.
  setInvert(invert)
Sets if this sensor activates on positive or negative events.
  setUseNegPulseMode(pulse)
Sets negative pulse mode.
  setUsePosPulseMode(pulse)
Sets positive pulse mode.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getBodies()

Gets the list of message bodies.
Returns:
list

getFrameMessageCount()

Get the number of messages received since the last frame.
Returns:
integer

getSubject()

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

getSubjects()

Gets the list of message subjects received.
Returns:
list

setSubjectFilterText(subject)

Change the message subject text that this sensor is listening to.
Parameters:
subject - the new message subject to listen for.
           (type=string)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net