Difference between revisions of "CutsceneCmdSendMessage"

Latest revision as of 02:12, 23 April 2013

This will send a message to a target object.

[edit] Defines

If using the Base toolbox with the Messenger system, you can uncomment a #define in this file to enable the message to be sent using that system instead.

Uncomment this at the top of the file:

  #define USE_MESSENGER

[edit] Public Variables

[edit] target : GameObject

This is the object to which the message is sent. It is only available if USE_MESSENGER is not defined.

[edit] targetTag : string

This is the tag to use to automatically set the target object, if desired. It is only available if USE_MESSENGER is not defined.

[edit] messageToSend : string

This is the message to send. It is sent using GameObject.SendMessage by default, or Messenger.Broadcast if USE_MESSENGER has been defined.

[edit] payload : string

This is data that is sent with the message. It's only sent if it has been set to something besides the empty string.

[edit] Public Functions

[edit] void SetMessage (string newMessage)

This sets the message name to send.

[edit] void SetPayload (string newPayload)

This sets the payload that will be sent with the message.