File: KX_NetworkMessageActuator.py

package info (click to toggle)
blender 2.36-1sarge1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 34,220 kB
  • ctags: 42,784
  • sloc: ansic: 280,846; cpp: 123,984; python: 18,428; sh: 7,178; makefile: 3,296; perl: 2,082; xml: 484; java: 8
file content (36 lines) | stat: -rw-r--r-- 885 bytes parent folder | download | duplicates (3)
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
# $Id: KX_NetworkMessageActuator.py,v 1.1 2004/06/02 12:43:26 kester Exp $
# Documentation for KX_NetworkMessageActuator
from SCA_IActuator import *

class KX_NetworkMessageActuator(SCA_IActuator):
	"""
	Message Actuator
	"""
	def setToPropName(name):
		"""
		Messages will only be sent to objects with the given property name.
		
		@type name: string
		"""
	def setSubject(subject):
		"""
		Sets the subject field of the message.
		
		@type subject: string
		"""
	def setBodyType(bodytype):
		"""
		Sets the type of body to send.
		
		@type bodytype: boolean
		@param bodytype: True to send the value of a property, False to send the body text.
		"""
	def setBody(body):
		"""
		Sets the message body.
		
		@type body: string
		@param body: if the body type is True, this is the name of the property to send.
		             if the body type is False, this is the text to send.
		"""