PixelCrushers.QuestMachine.QuestStateQuestCondition Class Reference

Quest condition that becomes true when another quest reaches a specified state. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestStateQuestCondition:

Collaboration diagram for PixelCrushers.QuestMachine.QuestStateQuestCondition:

Public Member Functions
override string	GetEditorName ()
	Returns the name to show in the editor for this subasset.
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 void	AddTagsToDictionary ()
	Records the static tags used in this asset's text content into the quest's staticTags property.
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.

Protected Member Functions
bool	IsConditionTrue (QuestState state)
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.

Properties
Quest	requiredQuest [get, set]
	Quest to monitor.
StringField	requiredQuestID [get, set]
	ID of quest to monitor.
bool	isNot [get, set]
	If true, quest must not be the required state.
StringField	questIDToCheck [get]
QuestState	requiredState [get, set]
	State that monitored quest must be in.
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 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 when another quest reaches a specified state.

Member Function Documentation

GetEditorName()

override string PixelCrushers.QuestMachine.QuestStateQuestCondition.GetEditorName ( )

inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

IsConditionTrue()

bool PixelCrushers.QuestMachine.QuestStateQuestCondition.IsConditionTrue ( QuestState  state )

inlineprotected

StartChecking()

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

inlinevirtual

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

Parameters

trueAction

The method to invoke when the condition becomes true.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

StopChecking()

override void PixelCrushers.QuestMachine.QuestStateQuestCondition.StopChecking ( )

inlinevirtual

Tells the condition to stop checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

Property Documentation

isNot

bool PixelCrushers.QuestMachine.QuestStateQuestCondition.isNot

getset

If true, quest must not be the required state.

questIDToCheck

StringField PixelCrushers.QuestMachine.QuestStateQuestCondition.questIDToCheck

get

requiredQuest

Quest PixelCrushers.QuestMachine.QuestStateQuestCondition.requiredQuest

getset

Quest to monitor.

If set, this takes priority over Required Quest ID. If neither is set, uses this quest.

requiredQuestID

StringField PixelCrushers.QuestMachine.QuestStateQuestCondition.requiredQuestID

getset

ID of quest to monitor.

Used if Required Quest is unassigned. If neither is set, uses this quest.

requiredState

QuestState PixelCrushers.QuestMachine.QuestStateQuestCondition.requiredState

getset

State that monitored quest must be in.

---

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 Condition/QuestStateQuestCondition.cs