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

Icon UI content (image with optional count and caption) with an optional list of actions. More...

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

Public Member Functions

override string GetEditorName ()
 Returns the name to show in the editor for this subasset.
 
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 SetDefaultTextTable (TextTable textTable)
 
- Public Member Functions inherited from PixelCrushers.QuestMachine.QuestContent
override void AddTagsToDictionary ()
 Records the static tags used in this asset's text content into the quest's staticTags property.
 
- Public Member Functions inherited from PixelCrushers.QuestMachine.QuestSubasset
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 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 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

Sprite image [get, set]
 The image.
 
Color color [get, set]
 Image color.
 
virtual StringField caption [get, set]
 The caption.
 
virtual int count [get, set]
 The count to show on the count label.
 
override StringField originalText [get, set]
 
virtual string captionText [get]
 
- Properties inherited from PixelCrushers.QuestMachine.QuestContent
int contentID [get, set]
 
virtual StringField originalText [get, set]
 
virtual string runtimeText [get]
 
- 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.QuestContent
static void SetRuntimeReferences (List< QuestContent > contentList, Quest quest, QuestNode questNode)
 
- 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

Icon UI content (image with optional count and caption) with an optional list of actions.

If the list of actions is non-empty, the icon acts as a button.

Member Function Documentation

◆ GetEditorName()

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

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

Reimplemented in PixelCrushers.QuestMachine.ORKSupport.ORKIconQuestContent.

◆ OnAfterProxyDeserialization()

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

◆ SetDefaultTextTable()

override void PixelCrushers.QuestMachine.IconQuestContent.SetDefaultTextTable ( TextTable  textTable)
inlinevirtual

Property Documentation

◆ caption

virtual StringField PixelCrushers.QuestMachine.IconQuestContent.caption
getset

The caption.

Can be blank.

◆ captionText

virtual string PixelCrushers.QuestMachine.IconQuestContent.captionText
get

◆ color

Color PixelCrushers.QuestMachine.IconQuestContent.color
getset

Image color.

◆ count

virtual int PixelCrushers.QuestMachine.IconQuestContent.count
getset

The count to show on the count label.

If 0 or 1, count is not shown.

◆ image

Sprite PixelCrushers.QuestMachine.IconQuestContent.image
getset

The image.

◆ originalText

override StringField PixelCrushers.QuestMachine.IconQuestContent.originalText
getset

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