Button UI content that executes actions when clicked. More...

Inheritance diagram for PixelCrushers.QuestMachine.ButtonQuestContent:

[legend]

Collaboration diagram for PixelCrushers.QuestMachine.ButtonQuestContent:

[legend]

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

Public Member Functions inherited from PixelCrushers.QuestMachine.IconQuestContent
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 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	DestroySubassets ()
	Allows subclasses to destroy their subassets, usually when a runtime instance of a quest is being destroyed.

Public Attributes
QuestActionProxyContainer	m_actionsProxy

Static Public Attributes
const int	NoGroup = -1

Properties
int	groupNumber `[get, set]`
	Group number this button belongs to, or -1 if none.

List< QuestAction >	actionList `[get, set]`
	The actions to run when the button is clicked.

virtual bool	interactable `[get]`

Properties inherited from PixelCrushers.QuestMachine.IconQuestContent
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

Button UI content that executes actions when clicked.

Member Function Documentation

◆ CloneSubassetsInto()

override void PixelCrushers.QuestMachine.ButtonQuestContent.CloneSubassetsInto ( QuestSubasset copy )

inlinevirtual

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

Parameters

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

◆ GetEditorName()

override string PixelCrushers.QuestMachine.ButtonQuestContent.GetEditorName ( )

inlinevirtual

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

Reimplemented from PixelCrushers.QuestMachine.QuestSubasset.

◆ OnAfterProxyDeserialization()

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

Member Data Documentation

◆ m_actionsProxy

QuestActionProxyContainer PixelCrushers.QuestMachine.ButtonQuestContent.m_actionsProxy

◆ NoGroup

const int PixelCrushers.QuestMachine.ButtonQuestContent.NoGroup = -1

static

Property Documentation

◆ actionList

List<QuestAction> PixelCrushers.QuestMachine.ButtonQuestContent.actionList

getset

The actions to run when the button is clicked.

◆ groupNumber

int PixelCrushers.QuestMachine.ButtonQuestContent.groupNumber

getset

Group number this button belongs to, or -1 if none.

When one button in the group is clicked, the other buttons become non-interactable.

◆ interactable

virtual bool PixelCrushers.QuestMachine.ButtonQuestContent.interactable

get

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

C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest/Quest Subasset/Quest Content/ButtonQuestContent.cs

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CloneSubassetsInto()

◆ GetEditorName()

◆ OnAfterProxyDeserialization()

◆ OnBeforeProxySerialization()

◆ SetRuntimeReferences()

Member Data Documentation

◆ m_actionsProxy

◆ NoGroup

Property Documentation

◆ actionList

◆ groupNumber

◆ interactable