Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / KX_NetworkMessageSensor.py
1 # Documentation for KX_NetworkMessageSensor
2 from SCA_ISensor import *
3
4 class KX_NetworkMessageSensor(SCA_ISensor):
5         """
6         The Message Sensor logic brick.
7         
8         Currently only loopback (local) networks are supported.
9         """
10         def setSubjectFilterText(subject):
11                 """
12                 Change the message subject text that this sensor is listening to.
13                 
14                 @type subject: string
15                 @param subject: the new message subject to listen for.
16                 """
17         
18         def getFrameMessageCount():
19                 """
20                 Get the number of messages received since the last frame.
21                 
22                 @rtype: integer
23                 """
24         def getBodies():
25                 """
26                 Gets the list of message bodies.
27                 
28                 @rtype: list
29                 """
30         def getSubject():
31                 """
32                 Gets the message subject this sensor is listening for from the Subject: field.
33                 
34                 @rtype: string
35                 """
36         def getSubjects():
37                 """
38                 Gets the list of message subjects received.
39                 
40                 @rtype list
41                 """
42