← Back to branch summary

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

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/KX_NetworkMessageActuator.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
http://bugs.debian.org/333958
* 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:
source/gameengine/PyDoc/KX_NetworkMessageActuator.py
 
1
# $Id: KX_NetworkMessageActuator.py,v 1.1 2004/06/02 12:43:26 kester Exp $
 
2
# Documentation for KX_NetworkMessageActuator
 
3
from SCA_IActuator import *
 
4
 
 
5
class KX_NetworkMessageActuator(SCA_IActuator):
 
6
        """
 
7
        Message Actuator
 
8
        """
 
9
        def setToPropName(name):
 
10
                """
 
11
                Messages will only be sent to objects with the given property name.
 
12
                
 
13
                @type name: string
 
14
                """
 
15
        def setSubject(subject):
 
16
                """
 
17
                Sets the subject field of the message.
 
18
                
 
19
                @type subject: string
 
20
                """
 
21
        def setBodyType(bodytype):
 
22
                """
 
23
                Sets the type of body to send.
 
24
                
 
25
                @type bodytype: boolean
 
26
                @param bodytype: True to send the value of a property, False to send the body text.
 
27
                """
 
28
        def setBody(body):
 
29
                """
 
30
                Sets the message body.
 
31
                
 
32
                @type body: string
 
33
                @param body: if the body type is True, this is the name of the property to send.
 
34
                             if the body type is False, this is the text to send.
 
35
                """
 
36