Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
PixelCrushers.QuestMachine.QuestSubasset Class Referenceabstract

Abstract base class for quest subassets (ScriptableObjects) such as QuestCondition, QuestAction, and QuestContent. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestSubasset:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.QuestMachine.QuestSubasset:
Collaboration graph
[legend]

Public Member Functions

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

Static Public Member Functions

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

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

Detailed Description

Abstract base class for quest subassets (ScriptableObjects) such as QuestCondition, QuestAction, and QuestContent.

Adds references to a Quest and QuestNode, and handles serialization and instance management.

Member Function Documentation

◆ AddTagsToDictionary() [1/3]

virtual void PixelCrushers.QuestMachine.QuestSubasset.AddTagsToDictionary ( )
inlinevirtual

Records the static tags used in this asset's text content into the quest's staticTags property.

Reimplemented in PixelCrushers.QuestMachine.MessageQuestAction, PixelCrushers.QuestMachine.MessageQuestCondition, and PixelCrushers.QuestMachine.QuestContent.

◆ AddTagsToDictionary() [2/3]

virtual void PixelCrushers.QuestMachine.QuestSubasset.AddTagsToDictionary ( string  s)
inlineprotectedvirtual

Adds any tags in the string to the tags dictionary.

Parameters
s

◆ AddTagsToDictionary() [3/3]

virtual void PixelCrushers.QuestMachine.QuestSubasset.AddTagsToDictionary ( StringField  stringField)
inlineprotectedvirtual

Adds any tags in the StringField to the tags dictionary.

Parameters
stringField

◆ CloneList< T >()

static List< T > PixelCrushers.QuestMachine.QuestSubasset.CloneList< T > ( List< T >  original,
Quest  quest = null 
)
inlinestatic

Returns a deep copy of a QuestSubasset list.

Type Constraints
T :QuestSubasset 

◆ CloneSubassetsInto()

virtual void PixelCrushers.QuestMachine.QuestSubasset.CloneSubassetsInto ( QuestSubasset  copy)
inlinevirtual

Allows subclasses to deep copy their own subassets by instantiating copies.

Parameters
copyThe copy to instantiate subasset copies into. Assumes the copy has already been instantiated and contains an accurate copy of everything except subassets.

Reimplemented in PixelCrushers.QuestMachine.AlertQuestAction, and PixelCrushers.QuestMachine.ButtonQuestContent.

◆ DestroyList< T >()

static void PixelCrushers.QuestMachine.QuestSubasset.DestroyList< T > ( List< T >  list)
inlinestatic
Type Constraints
T :QuestSubasset 

◆ DestroySubassets()

virtual void PixelCrushers.QuestMachine.QuestSubasset.DestroySubassets ( )
inlinevirtual

Allows subclasses to destroy their subassets, usually when a runtime instance of a quest is being destroyed.

Reimplemented in PixelCrushers.QuestMachine.AlertQuestAction.

◆ GetAudioClips()

virtual AudioClip[] PixelCrushers.QuestMachine.QuestSubasset.GetAudioClips ( )
inlinevirtual

Overide to return any audio clips that this content references.

Returns
Array of audio clips referenced by this content.

Reimplemented in PixelCrushers.QuestMachine.AlertQuestAction, PixelCrushers.QuestMachine.AudioQuestAction, and PixelCrushers.QuestMachine.AudioClipQuestContent.

◆ GetEditorName()

virtual string PixelCrushers.QuestMachine.QuestSubasset.GetEditorName ( )
inlinevirtual

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

Reimplemented in PixelCrushers.QuestMachine.ArticyQuestAction, PixelCrushers.QuestMachine.ArticyQuestCondition, PixelCrushers.QuestMachine.ArticyLocalizedQuestContent, PixelCrushers.QuestMachine.AddInventoryEngineItemQuestAction, PixelCrushers.QuestMachine.InventoryEngineHasItemsQuestCondition, PixelCrushers.QuestMachine.CompassProPOIQuestAction, PixelCrushers.QuestMachine.SetDMMapIconQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIDamageQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIEmoteQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIFollowQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIKillQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetBehaviorQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetConfidenceQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetDestinationQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetFactionRelation, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetItemQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetWanderQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAISetWeaponQuestAction, PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIUpdateTargetTagsQuestAction, PixelCrushers.QuestMachine.AddInventoryEngineItemQuestAction, PixelCrushers.QuestMachine.InventoryEngineHasItemsQuestCondition, PixelCrushers.QuestMachine.InventoryProCurrencyQuestAction, PixelCrushers.QuestMachine.InventoryProItemQuestAction, PixelCrushers.QuestMachine.InventoryProStatQuestAction, PixelCrushers.QuestMachine.InventoryProXPQuestAction, PixelCrushers.QuestMachine.InventoryProCurrencyQuestCondition, PixelCrushers.QuestMachine.InventoryProItemQuestCondition, PixelCrushers.QuestMachine.InventoryProStatQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKCurrencyQuestAction, PixelCrushers.QuestMachine.ORKSupport.ORKEventQuestAction, PixelCrushers.QuestMachine.ORKSupport.ORKGiveExpQuestAction, PixelCrushers.QuestMachine.ORKSupport.ORKItemQuestAction, PixelCrushers.QuestMachine.ORKSupport.ORKSetVariableQuestAction, PixelCrushers.QuestMachine.ORKSupport.ORKHasCurrencyQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKHasFactionSympathyQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKHasItemQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKLevelQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKVariableQuestCondition, PixelCrushers.QuestMachine.ORKSupport.ORKIconQuestContent, PixelCrushers.QuestMachine.OpsiveUCCSupport.AddUCCItemQuestAction, PixelCrushers.QuestMachine.OpsiveUCCSupport.SetUCCAttributeQuestAction, PixelCrushers.QuestMachine.OpsiveUCCSupport.UCCAttributeQuestCondition, PixelCrushers.QuestMachine.OpsiveUCCSupport.UCCItemCountQuestCondition, PixelCrushers.QuestMachine.uMMORPGAddExpQuestAction, PixelCrushers.QuestMachine.uMMORPGAddGoldQuestAction, PixelCrushers.QuestMachine.uMMORPGAddItemQuestAction, PixelCrushers.QuestMachine.uMMORPGAddSkillExpQuestAction, PixelCrushers.QuestMachine.uMMORPGSetSkillLevelQuestAction, PixelCrushers.QuestMachine.uMMORPGCanLearnSkillQuestCondition, PixelCrushers.QuestMachine.uMMORPGClassQuestCondition, PixelCrushers.QuestMachine.uMMORPGItemAmountQuestCondition, PixelCrushers.QuestMachine.uMMORPGLevelQuestCondition, PixelCrushers.QuestMachine.uMMORPGSkillLevelQuestCondition, PixelCrushers.QuestMachine.uSurvivalAddItemQuestAction, PixelCrushers.QuestMachine.uSurvivalModifyStatQuestAction, PixelCrushers.QuestMachine.uSurvivalHasItemsQuestCondition, PixelCrushers.QuestMachine.Demo.DemoItemCountQuestCondition, PixelCrushers.QuestMachine.Demo.DemoUpdateItemCounterQuestAction, PixelCrushers.QuestMachine.ActivateGameObjectQuestAction, PixelCrushers.QuestMachine.AlertQuestAction, PixelCrushers.QuestMachine.AnimatorQuestAction, PixelCrushers.QuestMachine.AudioQuestAction, PixelCrushers.QuestMachine.ControlSpawnerQuestAction, PixelCrushers.QuestMachine.GiveQuestToQuesterQuestAction, PixelCrushers.QuestMachine.InstantiatePrefabQuestAction, PixelCrushers.QuestMachine.MessageQuestAction, PixelCrushers.QuestMachine.SceneEventQuestAction, PixelCrushers.QuestMachine.SetCounterValueQuestAction, PixelCrushers.QuestMachine.SetIndicatorQuestAction, PixelCrushers.QuestMachine.SetQuestNodeStateQuestAction, PixelCrushers.QuestMachine.SetQuestStateQuestAction, PixelCrushers.QuestMachine.SetTrackingQuestAction, PixelCrushers.QuestMachine.UnityEventQuestAction, PixelCrushers.QuestMachine.CounterQuestCondition, PixelCrushers.QuestMachine.MessageQuestCondition, PixelCrushers.QuestMachine.ParentQuestCondition, PixelCrushers.QuestMachine.QuestNodeStateQuestCondition, PixelCrushers.QuestMachine.QuestStateQuestCondition, PixelCrushers.QuestMachine.TimerQuestCondition, PixelCrushers.QuestMachine.AudioClipQuestContent, PixelCrushers.QuestMachine.BodyTextQuestContent, PixelCrushers.QuestMachine.ButtonQuestContent, PixelCrushers.QuestMachine.HeadingTextQuestContent, PixelCrushers.QuestMachine.IconQuestContent, and PixelCrushers.QuestMachine.LinkQuestContent.

◆ GetImages()

virtual Sprite[] PixelCrushers.QuestMachine.QuestSubasset.GetImages ( )
inlinevirtual

Override to return any images that this content references.

Returns
Array of images referenced by this content.

Reimplemented in PixelCrushers.QuestMachine.AlertQuestAction.

◆ OnAfterProxyDeserialization()

virtual void PixelCrushers.QuestMachine.QuestSubasset.OnAfterProxyDeserialization ( )
inlinevirtual

Applies saved information from a proxy object.

The base method doesn't do anything, but subclasses may need to.

Implements PixelCrushers.QuestMachine.IProxySerializationCallbackReceiver.

Reimplemented in PixelCrushers.QuestMachine.SetDMMapIconQuestAction, PixelCrushers.QuestMachine.AlertQuestAction, PixelCrushers.QuestMachine.AudioQuestAction, PixelCrushers.QuestMachine.AudioClipQuestContent, PixelCrushers.QuestMachine.ButtonQuestContent, and PixelCrushers.QuestMachine.IconQuestContent.

◆ OnBeforeProxySerialization()

virtual void PixelCrushers.QuestMachine.QuestSubasset.OnBeforeProxySerialization ( )
inlinevirtual

Allows a subasset to save information in a serializable format prior to being serialized to a proxy object for saving.

The base method doesn't do anything, but subclasses may need to.

Implements PixelCrushers.QuestMachine.IProxySerializationCallbackReceiver.

Reimplemented in PixelCrushers.QuestMachine.SetDMMapIconQuestAction, PixelCrushers.QuestMachine.AlertQuestAction, PixelCrushers.QuestMachine.AudioQuestAction, PixelCrushers.QuestMachine.AudioClipQuestContent, PixelCrushers.QuestMachine.ButtonQuestContent, and PixelCrushers.QuestMachine.IconQuestContent.

◆ SetRuntimeReferences()

virtual void PixelCrushers.QuestMachine.QuestSubasset.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 in PixelCrushers.QuestMachine.AlertQuestAction, PixelCrushers.QuestMachine.QuestCondition, and PixelCrushers.QuestMachine.ButtonQuestContent.

Property Documentation

◆ quest

Quest PixelCrushers.QuestMachine.QuestSubasset.quest
getprotected set

(Runtime) The quest that this condition belongs to.

◆ questNode

QuestNode PixelCrushers.QuestMachine.QuestSubasset.questNode
getprotected set

(Runtime) The quest node that this condition belongs to.

◆ tagDictionary

TagDictionary PixelCrushers.QuestMachine.QuestSubasset.tagDictionary
getprotected

(Runtime) The quest's tag dictionary.

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