Module KX_NetworkMessageActuator :: Class KX_NetworkMessageActuator

Class KX_NetworkMessageActuator

SCA_ILogicBrick.SCA_ILogicBrick --+    
                                  |    
        SCA_IActuator.SCA_IActuator --+
                                      |
                                     KX_NetworkMessageActuator

Message Actuator

Instance Methods
 
setToPropName(name)
DEPRECATED: Use the propName property instead.
 
setSubject(subject)
DEPRECATED: Use the subject property instead.
 
setBodyType(bodytype)
DEPRECATED: Use the usePropBody property instead.
 
setBody(body)
DEPRECATED: Use the body property instead.
integer
getExecutePriority()
Gets the execution priority of this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject
getOwner()
Gets the game object associated with this logic brick. (Inherited from SCA_ILogicBrick.SCA_ILogicBrick)
 
setExecutePriority(priority)
Sets the priority of this logic brick. (Inherited from SCA_ILogicBrick.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 SCA_ILogicBrick.SCA_ILogicBrick)
KX_GameObject or None in exceptional cases. owner
The game object this logic brick is attached to (read only). (Inherited from SCA_ILogicBrick.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)

 

DEPRECATED: Use the propName property instead. Messages will only be sent to objects with the given property name.

Parameters:
  • name (string)

setSubject(subject)

 

DEPRECATED: Use the subject property instead. Sets the subject field of the message.

Parameters:
  • subject (string)

setBodyType(bodytype)

 

DEPRECATED: Use the usePropBody property instead. Sets the type of body to send.

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

setBody(body)

 

DEPRECATED: Use the body property instead. 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.