Loading...
Searching...
No Matches
PixelCrushers.QuestMachine.MessageQuestCondition Class Reference

Quest condition that becomes true on receipt of a message from the MessageSystem. More...

Inheritance diagram for PixelCrushers.QuestMachine.MessageQuestCondition:
Collaboration diagram for PixelCrushers.QuestMachine.MessageQuestCondition:

Public Member Functions

override string GetEditorName ()
 Returns the name to show in the editor for this subasset.
 
override void AddTagsToDictionary ()
 Records the static tags used in this asset's text content into the quest's staticTags property.
 
override void StartChecking (System.Action trueAction)
 Tells the condition to start checking; when true, call SetTrue().
 
override void StopChecking ()
 Tells the condition to stop checking.
 
- Public Member Functions inherited from PixelCrushers.QuestMachine.QuestCondition
override 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 void SetTrue ()
 Sets the condition true, invoking the trueAction.
 
virtual void ResetState ()
 Resets back to the non-true state.
 
- Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
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]
 Required message sender ID, or any sender if blank.
 
QuestMessageParticipant targetSpecifier [get, set]
 Required message target.
 
StringField targetID [get, set]
 Required message target ID, or any target if blank.
 
StringField message [get, set]
 Required message.
 
StringField parameter [get, set]
 Required parameter for message.
 
MessageValue value [get, set]
 Additional value to expected with the message.
 
string runtimeSenderID [get]
 
string runtimeTargetID [get]
 
string runtimeMessage [get]
 
string runtimeParameter [get]
 
string runtimeStringValue [get]
 
- Properties inherited from PixelCrushers.QuestMachine.QuestCondition
virtual bool isChecking [get, set]
 True if the condition is currently monitoring the requirements that would make it true.
 
virtual bool alreadyTrue [get, set]
 
- 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.
 
- Protected Attributes inherited from PixelCrushers.QuestMachine.QuestCondition
System.Action trueAction = delegate { }
 Delegate to call when the condition becomes true.
 

Detailed Description

Quest condition that becomes true on receipt of a message from the MessageSystem.

Member Function Documentation

◆ AddTagsToDictionary()

override void PixelCrushers.QuestMachine.MessageQuestCondition.AddTagsToDictionary ( )
inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ GetEditorName()

override string PixelCrushers.QuestMachine.MessageQuestCondition.GetEditorName ( )
inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ StartChecking()

override void PixelCrushers.QuestMachine.MessageQuestCondition.StartChecking ( System::Action  trueAction)
inlinevirtual

Tells the condition to start checking; when true, call SetTrue().

Parameters
trueActionThe method to invoke when the condition becomes true.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

◆ StopChecking()

override void PixelCrushers.QuestMachine.MessageQuestCondition.StopChecking ( )
inlinevirtual

Tells the condition to stop checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

Property Documentation

◆ message

StringField PixelCrushers.QuestMachine.MessageQuestCondition.message
getset

Required message.

Condition is true when this message is received with the parameter below.

◆ parameter

StringField PixelCrushers.QuestMachine.MessageQuestCondition.parameter
getset

Required parameter for message.

Condition is true when the message above is received with this parameter. (Leave blank to accept any parameter.)

◆ runtimeMessage

string PixelCrushers.QuestMachine.MessageQuestCondition.runtimeMessage
get

◆ runtimeParameter

string PixelCrushers.QuestMachine.MessageQuestCondition.runtimeParameter
get

◆ runtimeSenderID

string PixelCrushers.QuestMachine.MessageQuestCondition.runtimeSenderID
get

◆ runtimeStringValue

string PixelCrushers.QuestMachine.MessageQuestCondition.runtimeStringValue
get

◆ runtimeTargetID

string PixelCrushers.QuestMachine.MessageQuestCondition.runtimeTargetID
get

◆ senderID

StringField PixelCrushers.QuestMachine.MessageQuestCondition.senderID
getset

Required message sender ID, or any sender if blank.

Can also be {QUESTERID} or {QUESTGIVERID}. Sender must have a Quest Giver or Entity component.

◆ senderSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.MessageQuestCondition.senderSpecifier
getset

Required message sender.

◆ targetID

StringField PixelCrushers.QuestMachine.MessageQuestCondition.targetID
getset

Required message target ID, or any target if blank.

Can also be {QUESTERID} or {QUESTGIVERID}. Target must have a Quest Giver or Entity component.

◆ targetSpecifier

QuestMessageParticipant PixelCrushers.QuestMachine.MessageQuestCondition.targetSpecifier
getset

Required message target.

◆ value

MessageValue PixelCrushers.QuestMachine.MessageQuestCondition.value
getset

Additional value to expected with the message.


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