2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / PyDoc / KX_NetworkMessageSensor.py
1 # $Id$
2 # Documentation for KX_NetworkMessageSensor
3 from SCA_ISensor import *
4
5 class KX_NetworkMessageSensor(SCA_ISensor):
6         """
7         The Message Sensor logic brick.
8         
9         Currently only loopback (local) networks are supported.
10         
11         @ivar subject: The subject the sensor is looking for.
12         @type subject: string
13         @ivar frameMessageCount: The number of messages received since the last frame.
14                                                                 (Read-only)
15         @type framemessageCount: int
16         @ivar subjects: The list of message subjects received. (Read-only)
17         @type subjects: list of strings
18         @ivar bodies: The list of message bodies received. (Read-only)
19         @type bodies: list of strings
20         """
21         
22         
23         def setSubjectFilterText(subject):
24                 """
25                 DEPRECATED: Use the subject property instead.
26                 Change the message subject text that this sensor is listening to.
27                 
28                 @type subject: string
29                 @param subject: the new message subject to listen for.
30                 """
31         
32         def getFrameMessageCount():
33                 """
34                 DEPRECATED: Use the frameMessageCount property instead.
35                 Get the number of messages received since the last frame.
36                 
37                 @rtype: integer
38                 """
39         def getBodies():
40                 """
41                 DEPRECATED: Use the bodies property instead.
42                 Gets the list of message bodies.
43                 
44                 @rtype: list
45                 """
46         def getSubject():
47                 """
48                 DEPRECATED: Use the subject property instead.
49                 Gets the message subject this sensor is listening for from the Subject: field.
50                 
51                 @rtype: string
52                 """
53         def getSubjects():
54                 """
55                 DEPRECATED: Use the subjects property instead.
56                 Gets the list of message subjects received.
57                 
58                 @rtype: list
59                 """
60