Module GameTypes :: Class KX_NetworkMessageActuator

Class KX_NetworkMessageActuator

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

Message Actuator

Instance Methods

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

Deprecated

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

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

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

setBody(body)
Sets the message body.

integer

getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

KX_GameObject

getOwner()
Gets the game object associated with this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from GameTypes.SCA_ILogicBrick)

Instance Variables
string	body The body of the message.
int	executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first). (Inherited from GameTypes.SCA_ILogicBrick)
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases.	owner The game object this logic brick is attached to (read-only). (Inherited from GameTypes.SCA_ILogicBrick)
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.

Method Details

setToPropName(name)

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

Parameters:

name (string)

Deprecated: Use the propName attribute instead.

setSubject(subject)

Sets the subject field of the message.

Parameters:

subject (string)

Deprecated: Use the subject attribute instead.

setBodyType(bodytype)

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)

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.