PixelCrushers.QuestMachine.CounterQuestCondition Class Reference

Quest condition that becomes true when a counter reaches a specified value. More...

Inheritance diagram for PixelCrushers.QuestMachine.CounterQuestCondition:

Collaboration diagram for PixelCrushers.QuestMachine.CounterQuestCondition:

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
virtual void	OnCounterChanged (QuestCounter counter)
virtual bool	IsCounterConditionTrue (QuestCounter counter)
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
int	counterIndex [get, set]
	Index of a counter defined in the quest.
CounterValueConditionMode	counterValueMode [get, set]
	How the counter value applies to the condition.
QuestNumber	requiredCounterValue [get, set]
	The required value for the Counter Value Mode.
QuestCounter	counter [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 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 a counter reaches a specified value.

Member Function Documentation

GetEditorName()

override string PixelCrushers.QuestMachine.CounterQuestCondition.GetEditorName ( )

inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

IsCounterConditionTrue()

virtual bool PixelCrushers.QuestMachine.CounterQuestCondition.IsCounterConditionTrue ( QuestCounter  counter )

inlineprotectedvirtual

OnCounterChanged()

virtual void PixelCrushers.QuestMachine.CounterQuestCondition.OnCounterChanged ( QuestCounter  counter )

inlineprotectedvirtual

StartChecking()

override void PixelCrushers.QuestMachine.CounterQuestCondition.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.CounterQuestCondition.StopChecking ( )

inlinevirtual

Tells the condition to stop checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

Property Documentation

counter

QuestCounter PixelCrushers.QuestMachine.CounterQuestCondition.counter

get

counterIndex

int PixelCrushers.QuestMachine.CounterQuestCondition.counterIndex

getset

Index of a counter defined in the quest.

Inspect the quest's main info to view/edit counters.

counterValueMode

CounterValueConditionMode PixelCrushers.QuestMachine.CounterQuestCondition.counterValueMode

getset

How the counter value applies to the condition.

requiredCounterValue

QuestNumber PixelCrushers.QuestMachine.CounterQuestCondition.requiredCounterValue

getset

The required value for the Counter Value Mode.

---

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