PixelCrushers.DialogueSystem.QuestTracker Class Reference

When you attach this script to the Dialogue Manager object (or a child), it will display tracked quests. More...

Inheritance diagram for PixelCrushers.DialogueSystem.QuestTracker:

Collaboration diagram for PixelCrushers.DialogueSystem.QuestTracker:

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

Public Member Functions
void	Start ()
	Wait one frame after starting to update the tracker in case other start methods change the state of quests. More...
void	ShowTracker ()
void	HideTracker ()
void	ToggleTracker ()
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 ()

Public Attributes
string	playerPrefsToggleKey = "QuestTracker"
ScaledRect	rect
	The screen rect that will contain the tracker. More...
GUISkin	guiSkin
	The GUI skin to use for the tracker. More...
string	TitleStyle
	The GUI style to use for active quest titles. More...
string	SuccessTitleStyle
	The GUI style to use for successful quest titles. More...
string	FailureTitleStyle
	The GUI style to use for failed quest titles. More...
string	ActiveEntryStyle
	The GUI style to use for active quest entries. More...
string	SuccessEntryStyle
	The GUI style to use for successful quest entries. More...
string	FailureEntryStyle
	The GUI style to use for failed quest entries. 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.

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

strong

Enumerator
Title
Description

Member Function Documentation

HideTracker()

void PixelCrushers.DialogueSystem.QuestTracker.HideTracker

(

)

OnConversationEnd()

void PixelCrushers.DialogueSystem.QuestTracker.OnConversationEnd

(

Transform

actor

)

Quests are often completed in conversations.

This handles changes in quest states after conversations.

Parameters

actor

Actor.

OnQuestTrackingDisabled()

void PixelCrushers.DialogueSystem.QuestTracker.OnQuestTrackingDisabled

(

string

quest

)

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

Parameters

quest

Quest.

OnQuestTrackingEnabled()

void PixelCrushers.DialogueSystem.QuestTracker.OnQuestTrackingEnabled

(

string

quest

)

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

Parameters

quest

Quest.

ShowTracker()

void PixelCrushers.DialogueSystem.QuestTracker.ShowTracker

(

)

Start()

void PixelCrushers.DialogueSystem.QuestTracker.Start

(

)

Wait one frame after starting to update the tracker in case other start methods change the state of quests.

ToggleTracker()

void PixelCrushers.DialogueSystem.QuestTracker.ToggleTracker

(

)

UpdateTracker()

void PixelCrushers.DialogueSystem.QuestTracker.UpdateTracker

(

)

Member Data Documentation

ActiveEntryStyle

string PixelCrushers.DialogueSystem.QuestTracker.ActiveEntryStyle

The GUI style to use for active quest entries.

FailureEntryStyle

string PixelCrushers.DialogueSystem.QuestTracker.FailureEntryStyle

The GUI style to use for failed quest entries.

FailureTitleStyle

string PixelCrushers.DialogueSystem.QuestTracker.FailureTitleStyle

The GUI style to use for failed quest titles.

guiSkin

GUISkin PixelCrushers.DialogueSystem.QuestTracker.guiSkin

The GUI skin to use for the tracker.

playerPrefsToggleKey

string PixelCrushers.DialogueSystem.QuestTracker.playerPrefsToggleKey = "QuestTracker"

questDescriptionSource

QuestDescriptionSource PixelCrushers.DialogueSystem.QuestTracker.questDescriptionSource = QuestDescriptionSource.Title

rect

ScaledRect PixelCrushers.DialogueSystem.QuestTracker.rect

Initial value:

= new ScaledRect(ScaledRectAlignment.TopRight, ScaledRectAlignment.TopRight,
                                                ScaledValue.FromPixelValue(0), ScaledValue.FromPixelValue(0),
                                                ScaledValue.FromNormalizedValue(0.25f), ScaledValue.FromNormalizedValue(1f),
                                                64f, 32f)

The screen rect that will contain the tracker.

showActiveQuests

bool PixelCrushers.DialogueSystem.QuestTracker.showActiveQuests = true

Tick to show active quests in the tracker.

showCompletedEntryText

bool PixelCrushers.DialogueSystem.QuestTracker.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.QuestTracker.showCompletedQuests = false

Tick to show successful and failed quests in the tracker.

SuccessEntryStyle

string PixelCrushers.DialogueSystem.QuestTracker.SuccessEntryStyle

The GUI style to use for successful quest entries.

SuccessTitleStyle

string PixelCrushers.DialogueSystem.QuestTracker.SuccessTitleStyle

The GUI style to use for successful quest titles.

TitleStyle

string PixelCrushers.DialogueSystem.QuestTracker.TitleStyle

The GUI style to use for active quest titles.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Release/Assets/Dialogue System/Scripts/Supplemental/Utility/QuestTracker.cs