Module GameTypes :: Class KX_NetworkMessageActuator

Class KX_NetworkMessageActuator

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
     SCA_ILogicBrick --+    
                       |    
           SCA_IActuator --+
                           |
                          KX_NetworkMessageActuator

Message Actuator

Instance Methods

[hide private]

Deprecated

setToPropName(name)
Messages will only be sent to objects with the given property name.

source code

setSubject(subject)
Sets the subject field of the message.

source code

setBodyType(bodytype)
Sets the type of body to send.

source code

setBody(body)
Sets the message body.

source code

Inherited from SCA_ILogicBrick

integer

getExecutePriority()
Gets the execution priority of this logic brick.

source code

KX_GameObject

getOwner()
Gets the game object associated with this logic brick.

source code

setExecutePriority(priority)
Sets the priority of this logic brick.

source code

Inherited from CValue

string

getName()
Returns the name of the CValue.

source code

Inherited from PyObjectPlus

bool

isA(game_type)
Check if this is a type or a subtype game_type.

source code

Instance Variables

[hide private]

string

body
The body of the message.

string

propName
Messages will only be sent to objects with the given property name.

string

subject
The subject field of the message.

boolean

usePropBody
Send a property instead of a regular body message.

Inherited from SCA_ILogicBrick

int

executePriority
This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).

string

name
The name of this CValue derived object (read-only).

KX_GameObject or None in exceptional cases.

owner
The game object this logic brick is attached to (read-only).

Inherited from PyObjectPlus

bool

invalid
Test if the object has been freed by the game engine and is no longer valid.

Method Details

[hide private]

setToPropName(name)

source code

Messages will only be sent to objects with the given property name.

Deprecated: Use the propName attribute instead.

setSubject(subject)

source code

Sets the subject field of the message.

Deprecated: Use the subject attribute instead.

setBodyType(bodytype)

source code

Sets the type of body to send.

Parameters:

bodytype (boolean) - True to send the value of a property, False to send the body text.

Deprecated: Use the usePropBody attribute instead.

setBody(body)

source code

Sets the message body.

Parameters:

body (string) - 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.

Deprecated: Use the body attribute instead.