Loading...
Searching...
No Matches
PixelCrushers.QuestMachine.AlertQuestAction Class Reference

Sends a QuestAlert message with some UI content. More...

Inheritance diagram for PixelCrushers.QuestMachine.AlertQuestAction:
Collaboration diagram for PixelCrushers.QuestMachine.AlertQuestAction:

Public Member Functions

override string GetEditorName ()
 Returns the name to show in the editor for this subasset.
 
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.
 
override void Execute ()
 Performs the quest action.
 
override Sprite[] GetImages ()
 Override to return any images that this content references.
 
override AudioClip[] GetAudioClips ()
 Overide to return any audio clips that this content references.
 
override void OnBeforeProxySerialization ()
 Allows a subasset to save information in a serializable format prior to being serialized to a proxy object for saving.
 
override void OnAfterProxyDeserialization ()
 Applies saved information from a proxy object.
 
override void CloneSubassetsInto (QuestSubasset copy)
 Allows subclasses to deep copy their own subassets by instantiating copies.
 
override void DestroySubassets ()
 Allows subclasses to destroy their subassets, usually when a runtime instance of a quest is being destroyed.
 
- 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.
 

Properties

List< QuestContentcontentList [get, set]
 The content to show in the alert UI.
 
- 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

Sends a QuestAlert message with some UI content.

Member Function Documentation

◆ CloneSubassetsInto()

override void PixelCrushers.QuestMachine.AlertQuestAction.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 from PixelCrushers.QuestMachine.QuestSubasset.

◆ DestroySubassets()

override void PixelCrushers.QuestMachine.AlertQuestAction.DestroySubassets ( )
inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ Execute()

override void PixelCrushers.QuestMachine.AlertQuestAction.Execute ( )
inlinevirtual

Performs the quest action.

Reimplemented from PixelCrushers.QuestMachine.QuestAction.

◆ GetAudioClips()

override AudioClip[] PixelCrushers.QuestMachine.AlertQuestAction.GetAudioClips ( )
inlinevirtual

Overide to return any audio clips that this content references.

Returns
Array of audio clips referenced by this content.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ GetEditorName()

override string PixelCrushers.QuestMachine.AlertQuestAction.GetEditorName ( )
inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ GetImages()

override Sprite[] PixelCrushers.QuestMachine.AlertQuestAction.GetImages ( )
inlinevirtual

Override to return any images that this content references.

Returns
Array of images referenced by this content.

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ OnAfterProxyDeserialization()

override void PixelCrushers.QuestMachine.AlertQuestAction.OnAfterProxyDeserialization ( )
inlinevirtual

Applies saved information from a proxy object.

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ OnBeforeProxySerialization()

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ SetRuntimeReferences()

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

Property Documentation

◆ contentList

List<QuestContent> PixelCrushers.QuestMachine.AlertQuestAction.contentList
getset

The content to show in the alert UI.


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