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