~ubuntu-branches/ubuntu/gutsy/blender/gutsy-security

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/KX_NetworkMessageSensor.py

  • Committer: Bazaar Package Importer
  • Author(s): Florian Ernst
  • Date: 2005-11-06 12:40:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051106124003-3pgs7tcg5rox96xg
Tags: 2.37a-1.1
* Non-maintainer upload.
* Split out parts of 01_SConstruct_debian.dpatch again: root_build_dir
  really needs to get adjusted before the clean target runs - closes: #333958,
  see #288882 for reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# $Id: KX_NetworkMessageSensor.py,v 1.3 2004/05/31 13:06:04 kester Exp $
 
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
        def setSubjectFilterText(subject):
 
12
                """
 
13
                Change the message subject text that this sensor is listening to.
 
14
                
 
15
                @type subject: string
 
16
                @param subject: the new message subject to listen for.
 
17
                """
 
18
        
 
19
        def getFrameMessageCount():
 
20
                """
 
21
                Get the number of messages received since the last frame.
 
22
                
 
23
                @rtype: integer
 
24
                """
 
25
        def getBodies():
 
26
                """
 
27
                Gets the list of message bodies.
 
28
                
 
29
                @rtype: list
 
30
                """
 
31
        def getSubject():
 
32
                """
 
33
                Gets the message subject this sensor is listening for from the Subject: field.
 
34
                
 
35
                @rtype: string
 
36
                """
 
37
        def getSubjects():
 
38
                """
 
39
                Gets the list of message subjects received.
 
40
                
 
41
                @rtype: list
 
42
                """
 
43
        
 
 
b'\\ No newline at end of file'