PixelCrushers.QuestMachine.MessageQuestAction Class Reference

Sends a message to the MessageSystem. More...

Inheritance diagram for PixelCrushers.QuestMachine.MessageQuestAction:

Collaboration diagram for PixelCrushers.QuestMachine.MessageQuestAction:

Public Member Functions
override string	GetEditorName ()
	Returns the name to show in the editor for this subasset.
override void	Execute ()
	Performs the quest action.
override void	AddTagsToDictionary ()
	Records the static tags used in this asset's text content into the quest's staticTags property.
Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
virtual void	SetRuntimeReferences (Quest quest, QuestNode questNode)
	Sets quest references, as some subassets might need to refer to their containing quest and/or quest node.
virtual Sprite[]	GetImages ()
	Override to return any images that this content references.
virtual AudioClip[]	GetAudioClips ()
	Overide to return any audio clips that this content references.
virtual void	OnBeforeProxySerialization ()
	Allows a subasset to save information in a serializable format prior to being serialized to a proxy object for saving.
virtual void	OnAfterProxyDeserialization ()
	Applies saved information from a proxy object.
virtual void	CloneSubassetsInto (QuestSubasset copy)
	Allows subclasses to deep copy their own subassets by instantiating copies.
virtual void	DestroySubassets ()
	Allows subclasses to destroy their subassets, usually when a runtime instance of a quest is being destroyed.

Properties
QuestMessageParticipant	senderSpecifier [get, set]
	Required message sender.
StringField	senderID [get, set]
	ID of message sender.
QuestMessageParticipant	targetSpecifier [get, set]
	Required message target.
StringField	targetID [get, set]
	ID of message target.
StringField	message [get, set]
	Message to send.
StringField	parameter [get, set]
	Parameter to send with message.
MessageValue	value [get, set]
	Optional value to pass with message.
string	runtimeSenderID [get]
string	runtimeTargetID [get]
string	runtimeMessage [get]
string	runtimeParameter [get]
string	runtimeStringValue [get]
Properties inherited from PixelCrushers.QuestMachine.QuestSubasset
Quest	quest [get, protected set]
	(Runtime) The quest that this condition belongs to.
QuestNode	questNode [get, protected set]
	(Runtime) The quest node that this condition belongs to.
TagDictionary	tagDictionary [get]
	(Runtime) The quest's tag dictionary.

Additional Inherited Members
Static Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
static List< T >	CloneList< T > (List< T > original, Quest quest=null)
	Returns a deep copy of a QuestSubasset list.
static void	DestroyList< T > (List< T > list)
Protected Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
virtual void	AddTagsToDictionary (StringField stringField)
	Adds any tags in the StringField to the tags dictionary.
virtual void	AddTagsToDictionary (string s)
	Adds any tags in the string to the tags dictionary.

Detailed Description

Sends a message to the MessageSystem.

Member Function Documentation

AddTagsToDictionary()

override void PixelCrushers.QuestMachine.MessageQuestAction.AddTagsToDictionary ( )

inlinevirtual

Records the static tags used in this asset's text content into the quest's staticTags property.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

Execute()

override void PixelCrushers.QuestMachine.MessageQuestAction.Execute ( )

inlinevirtual

Performs the quest action.

Reimplemented from PixelCrushers.QuestMachine.QuestAction.

GetEditorName()

override string PixelCrushers.QuestMachine.MessageQuestAction.GetEditorName ( )

inlinevirtual

Returns the name to show in the editor for this subasset.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

Property Documentation

message

StringField PixelCrushers.QuestMachine.MessageQuestAction.message

getset

Message to send.

parameter

StringField PixelCrushers.QuestMachine.MessageQuestAction.parameter

getset

Parameter to send with message.

runtimeMessage

string PixelCrushers.QuestMachine.MessageQuestAction.runtimeMessage

get

runtimeParameter

string PixelCrushers.QuestMachine.MessageQuestAction.runtimeParameter

get

runtimeSenderID

string PixelCrushers.QuestMachine.MessageQuestAction.runtimeSenderID

get

runtimeStringValue

string PixelCrushers.QuestMachine.MessageQuestAction.runtimeStringValue

get

runtimeTargetID

string PixelCrushers.QuestMachine.MessageQuestAction.runtimeTargetID

get

senderID

StringField PixelCrushers.QuestMachine.MessageQuestAction.senderID

getset

ID of message sender.

If blank, uses quest giver's ID.

senderSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.MessageQuestAction.senderSpecifier

getset

Required message sender.

targetID

StringField PixelCrushers.QuestMachine.MessageQuestAction.targetID

getset

ID of message target.

Can also be {QUESTERID} or {QUESTGIVERID}. Leave blank to broadcast to all listeners.

targetSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.MessageQuestAction.targetSpecifier

getset

Required message target.

value

MessageValue PixelCrushers.QuestMachine.MessageQuestAction.value

getset

Optional value to pass with message.

---

The documentation for this class was generated from the following file:

• C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest/Quest Subasset/Quest Action/MessageQuestAction.cs