PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition Class Reference

Checks the amount of currency on a player. More...

Inheritance diagram for PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition:

Collaboration diagram for PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition:

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.
void	Tick ()
	Invoked when one second has passed.
override void	SetTrue ()
	Sets the condition true, invoking the trueAction.
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	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.

Properties
StringField	currencyName [get, set]
CounterValueConditionMode	mode [get, set]
QuestNumber	requiredValue [get, set]
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

Checks the amount of currency on a player.

Member Function Documentation

GetEditorName()

override string PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.GetEditorName ( )

inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

SetTrue()

override void PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.SetTrue ( )

inlinevirtual

Sets the condition true, invoking the trueAction.

Also stops checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

StartChecking()

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

inlinevirtual

Tells the condition to stop checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

Tick()

void PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.Tick ( )

inline

Invoked when one second has passed.

Implements PixelCrushers.QuestMachine.IQuestTimer.

Property Documentation

currencyName

StringField PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.currencyName

getset

mode

CounterValueConditionMode PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.mode

getset

requiredValue

QuestNumber PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition.requiredValue

getset

---

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

• C:/Dev/Quest Machine/Dev/Integration/Inventory Pro Integration/Assets/Pixel Crushers/Quest Machine/Third Party Support/Inventory Pro Support/Scripts/Quest Conditions/InventoryProCurrencyQuestCondition.cs