PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker Class Reference

When you attach this script to the Dialogue Manager object (or a child), it will display tracked quests using the new Unity UI and TextMeshPro. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker:

Collaboration diagram for PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker:

Public Types
enum	QuestDescriptionSource { QuestDescriptionSource.Title, QuestDescriptionSource.Description }

Public Member Functions
void	Start ()
	Wait 0.5s to update the tracker in case other start methods change the state of quests. More...
void	OnQuestTrackingEnabled (string quest)
	The quest log window sends this message when the player toggles tracking. More...
void	OnQuestTrackingDisabled (string quest)
	The quest log window sends this message when the player toggles tracking. More...
void	OnConversationEnd (Transform actor)
	Quests are often completed in conversations. More...
void	UpdateTracker ()
void	DestroyInstantiatedItems ()

Public Attributes
Transform	container
	The UI control that will hold quest track info (instantiated copies of the quest track template). More...
bool	showContainerIfEmpty = true
	Tick to show the container even if there's nothing to track. More...
TextMeshProQuestTrackTemplate	questTrackTemplate
	The quest track template. More...
bool	showActiveQuests = true
	Tick to show active quests in the tracker. More...
bool	showCompletedQuests = false
	Tick to show successful and failed quests in the tracker. More...
bool	showCompletedEntryText = false
	Tick to look up "Entry n Success" or "Entry n Failure" if the quest entry is in the success or failure state. More...
QuestDescriptionSource	questDescriptionSource = QuestDescriptionSource.Title

Detailed Description

When you attach this script to the Dialogue Manager object (or a child), it will display tracked quests using the new Unity UI and TextMeshPro.

It updates when the player toggles tracking in the quest log window and at the end of conversations. If you change the state of a quest elsewhere, you must manually call UpdateTracker().

Member Enumeration Documentation

QuestDescriptionSource

enum PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.QuestDescriptionSource

strong

Enumerator
Title
Description

Member Function Documentation

DestroyInstantiatedItems()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.DestroyInstantiatedItems

(

)

OnConversationEnd()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.OnConversationEnd

(

Transform

actor

)

Quests are often completed in conversations.

This handles changes in quest states after conversations.

Parameters

actor

Actor.

OnQuestTrackingDisabled()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.OnQuestTrackingDisabled

(

string

quest

)

The quest log window sends this message when the player toggles tracking.

Parameters

quest

Quest.

OnQuestTrackingEnabled()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.OnQuestTrackingEnabled

(

string

quest

)

The quest log window sends this message when the player toggles tracking.

Parameters

quest

Quest.

Start()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.Start

(

)

Wait 0.5s to update the tracker in case other start methods change the state of quests.

UpdateTracker()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.UpdateTracker

(

)

Member Data Documentation

container

Transform PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.container

The UI control that will hold quest track info (instantiated copies of the quest track template).

This is typically a Vertical Layout Group.

questDescriptionSource

QuestDescriptionSource PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.questDescriptionSource = QuestDescriptionSource.Title

questTrackTemplate

TextMeshProQuestTrackTemplate PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.questTrackTemplate

The quest track template.

showActiveQuests

bool PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.showActiveQuests = true

Tick to show active quests in the tracker.

showCompletedEntryText

bool PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.showCompletedEntryText = false

Tick to look up "Entry n Success" or "Entry n Failure" if the quest entry is in the success or failure state.

showCompletedQuests

bool PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.showCompletedQuests = false

Tick to show successful and failed quests in the tracker.

showContainerIfEmpty

bool PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestTracker.showContainerIfEmpty = true

Tick to show the container even if there's nothing to track.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/TextMeshPro Integration/Assets/Dialogue System/Third Party Support/TextMesh Pro/Scripts/Quest Log Window/TextMeshProQuestTracker.cs