PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition Class Reference

Base class for quest conditions that check something on a combatant. More...

Inheritance diagram for PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition:

Collaboration diagram for PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition:

Public Member Functions
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.
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 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 Member Functions
bool	IsConditionMet ()
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
bool	checkPlayer [get, set]
StringField	combatantName [get, set]
Combatant	combatant [get]
bool	usePlayer [get]
string	runtimeCombatantName [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

Base class for quest conditions that check something on a combatant.

Member Function Documentation

IsConditionMet()

bool PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.IsConditionMet ( )

abstractprotected

StartChecking()

override void PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.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.

Reimplemented in PixelCrushers.QuestMachine.ORKSupport.ORKHasCurrencyQuestCondition, and PixelCrushers.QuestMachine.ORKSupport.ORKHasFactionSympathyQuestCondition.

StopChecking()

override void PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.StopChecking ( )

inlinevirtual

Tells the condition to stop checking.

Reimplemented from PixelCrushers.QuestMachine.QuestCondition.

Tick()

void PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.Tick ( )

inline

Invoked when one second has passed.

Implements PixelCrushers.QuestMachine.IQuestTimer.

Property Documentation

checkPlayer

bool PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.checkPlayer

getset

combatant

Combatant PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.combatant

getprotected

combatantName

StringField PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.combatantName

getset

runtimeCombatantName

string PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.runtimeCombatantName

getprotected

usePlayer

bool PixelCrushers.QuestMachine.ORKSupport.ORKCombatantQuestCondition.usePlayer

getprotected

---

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

• C:/Dev/Quest Machine/Dev/Integration/ORK Integration/Assets/Pixel Crushers/Quest Machine/Third Party Support/ORK Framework Support/Scripts/Quest Conditions/ORKCombatantQuestCondition.cs