Abstract base class for quest conditions. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestCondition:

[legend]

Collaboration diagram for PixelCrushers.QuestMachine.QuestCondition:

[legend]

Public Member Functions
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	StartChecking (System.Action trueAction)
	Tells the condition to start checking; when true, call SetTrue().

virtual void	StopChecking ()
	Tells the condition to stop checking.

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 string	GetEditorName ()
	Returns the name to show in the editor for this subasset.

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 Attributes
System.Action	trueAction = delegate { }
	Delegate to call when the condition becomes true.

Properties
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.

Detailed Description

Abstract base class for quest conditions.

Member Function Documentation

◆ ResetState()

virtual void PixelCrushers.QuestMachine.QuestCondition.ResetState ( )

inlinevirtual

Resets back to the non-true state.

◆ SetRuntimeReferences()

override void PixelCrushers.QuestMachine.QuestCondition.SetRuntimeReferences	(	Quest	quest,
		QuestNode	questNode
	)

inlinevirtual

Sets quest references, as some subassets might need to refer to their containing quest and/or quest node.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ SetTrue()

virtual void PixelCrushers.QuestMachine.QuestCondition.SetTrue ( )

inlinevirtual

Sets the condition true, invoking the trueAction.

Also stops checking.

Reimplemented in PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition, PixelCrushers.QuestMachine.InventoryProItemQuestCondition, PixelCrushers.QuestMachine.OpsiveUCCSupport.UCCAttributeQuestCondition, and PixelCrushers.QuestMachine.OpsiveUCCSupport.UCCItemCountQuestCondition.

◆ StartChecking()

virtual void PixelCrushers.QuestMachine.QuestCondition.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.

◆ StopChecking()

virtual void PixelCrushers.QuestMachine.QuestCondition.StopChecking ( )

inlinevirtual

Tells the condition to stop checking.

Member Data Documentation

◆ trueAction

System.Action PixelCrushers.QuestMachine.QuestCondition.trueAction = delegate { }

protected

Delegate to call when the condition becomes true.

Property Documentation

◆ alreadyTrue

virtual bool PixelCrushers.QuestMachine.QuestCondition.alreadyTrue

getset

◆ isChecking

virtual bool PixelCrushers.QuestMachine.QuestCondition.isChecking

getsetprotected

True if the condition is currently monitoring the requirements that would make it true.

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/QuestCondition.cs

Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ResetState()

◆ SetRuntimeReferences()

◆ SetTrue()

◆ StartChecking()

◆ StopChecking()

Member Data Documentation

◆ trueAction

Property Documentation

◆ alreadyTrue

◆ isChecking