This is an implementation of the abstract QuestLogWindow class for Unity UI and TextMeshPro. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow:

Collaboration diagram for PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow:

[legend]

Classes
class	AnimationTransitions

Public Member Functions
override void	Awake ()

virtual void	Start ()
	Hide the main panel and all of the templates on start. More...

void	Update ()

override void	OpenWindow (Action openedWindowHandler)
	Open the window by showing the main panel. More...

override void	CloseWindow (Action closedWindowHandler)
	Close the window by hiding the main panel. More...

override void	OnQuestListUpdated ()
	Whenever the quest list is updated, repopulate the scroll panel. More...

void	NotifyContentChanged ()

void	ClickQuestFoldout (string questTitle)

override void	ConfirmAbandonQuest (string title, Action confirmAbandonQuestHandler)
	Opens the abandon confirmation popup. More...

void	ClickConfirmAbandonQuestButton ()

void	ClickCancelAbandonQuestButton ()

Public Member Functions inherited from PixelCrushers.DialogueSystem.QuestLogWindow
virtual void	Open ()
	Opens the quest window. More...

virtual void	Close ()
	Closes the quest log window. More...

virtual string	GetLocalizedText (string fieldName)
	Gets the localized text for a field name. More...

virtual bool	IsSelectedQuest (QuestInfo questInfo)
	Determines whether the specified questInfo is for the currently-selected quest. More...

void	ClickClose (object data)
	Your GUI close button should call this. More...

virtual void	ClickShowActiveQuests (object data)
	Your GUI "show active quests" button should call this. More...

virtual void	ClickShowCompletedQuests (object data)
	Your GUI "show completed quests" button should call this. More...

virtual void	ClickQuest (object data)
	Your GUI should call this when the player clicks on a quest to expand or close it. More...

virtual void	ClickAbandonQuest (object data)
	Your GUI should call this when the player clicks to abandon a quest. More...

virtual void	ClickTrackQuest (object data)
	Your GUI should call this when the player clicks to toggle quest tracking. More...

virtual void	ClickShowActiveQuestsButton ()

void	ClickShowCompletedQuestsButton ()

void	ClickCloseButton ()

void	ClickAbandonQuestButton ()

void	ClickTrackQuestButton ()

void	UpdateTracker ()

Public Attributes
UnityEngine.UI.Graphic	mainPanel
	The main quest log window panel. More...

UnityEngine.UI.Button	activeQuestsButton
	The active quests button. More...

UnityEngine.UI.Button	completedQuestsButton
	The completed quests button. More...

UnityEngine.UI.Graphic	questTable
	The quest table. More...

TextMeshProQuestTemplate	questTemplate
	The quest template. More...

UnityEngine.UI.Graphic	abandonPopup
	The confirmation popup to use if the player clicks the abandon quest button. More...

TMPro.TextMeshProUGUI	abandonQuestTitle
	The quest title label to set in the abandon quest dialog popup. More...

bool	autoFocus = false
	Set `true` to always keep a control focused; useful for gamepads. More...

UnityEvent	onContentChanged = new UnityEvent()

AnimationTransitions	animationTransitions = new AnimationTransitions()

Public Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
LocalizedTextTable	localizedText = null

QuestHeadingSource	questHeadingSource = QuestHeadingSource.Name
	The quest title source. More...

QuestState	abandonQuestState = QuestState.Unassigned
	The state to assign abandoned quests. More...

bool	pauseWhileOpen = true
	If `true`, the window sets `Time.timeScale = 0` to pause the game while displaying the quest log window. More...

bool	unlockCursorWhileOpen = true
	If `true`, the cursor is unlocked while the quest log window is open. More...

bool	useGroups = false
	If `true`, organize the quests by group. More...

Additional Inherited Members
Public Types inherited from PixelCrushers.DialogueSystem.QuestLogWindow
enum	QuestHeadingSource { QuestHeadingSource.Name, QuestHeadingSource.Description }

Protected Member Functions inherited from PixelCrushers.DialogueSystem.QuestLogWindow
virtual void	OnOpenedWindow ()

virtual void	OnClosedWindow ()

virtual void	PauseGameplay ()

virtual void	ResumeGameplay ()

virtual void	ShowQuests (QuestState questStateMask)

virtual QuestInfo	GetQuestInfo (string group, string title)

virtual string	GetNoQuestsMessage (QuestState questStateMask)
	Gets the "no quests" message for a quest state (active or success\|failure). More...

virtual void	OnConfirmAbandonQuest ()
	Your GUI should call this when the player confirms abandonment of a quest. More...

Protected Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
QuestState	currentQuestStateMask = QuestState.Active
	The current quest state mask. More...

Properties inherited from PixelCrushers.DialogueSystem.QuestLogWindow
bool	IsOpen `[get, protected set]`
	Indicates whether the quest log window is currently open. More...

QuestInfo[]	Quests `[get, protected set]`
	The current list of quests. More...

string[]	Groups `[get, protected set]`
	The current list of quest groups. More...

string	SelectedQuest `[get, protected set]`
	The title of the currently-selected quest. More...

string	NoQuestsMessage `[get, protected set]`
	The message to show if Quests[] is empty. More...

bool	IsShowingActiveQuests `[get]`
	Indicates whether the window is showing active quests or completed quests. More...

Detailed Description

This is an implementation of the abstract QuestLogWindow class for Unity UI and TextMeshPro.

Member Function Documentation

◆ Awake()

override void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.Awake ( )

virtual

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ ClickCancelAbandonQuestButton()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.ClickCancelAbandonQuestButton ( )

◆ ClickConfirmAbandonQuestButton()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.ClickConfirmAbandonQuestButton ( )

◆ ClickQuestFoldout()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.ClickQuestFoldout ( string questTitle )

◆ CloseWindow()

override void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.CloseWindow ( Action closedWindowHandler )

virtual

Close the window by hiding the main panel.

Re-enable the bark UI.

Parameters

closedWindowHandler Closed window handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ ConfirmAbandonQuest()

override void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.ConfirmAbandonQuest	(	string	title,
		Action	confirmAbandonQuestHandler
	)

virtual

Opens the abandon confirmation popup.

Parameters

title	Quest title.
confirmAbandonQuestHandler	Confirm abandon quest handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ NotifyContentChanged()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.NotifyContentChanged ( )

◆ OnQuestListUpdated()

override void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.OnQuestListUpdated ( )

virtual

Whenever the quest list is updated, repopulate the scroll panel.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ OpenWindow()

override void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.OpenWindow ( Action openedWindowHandler )

virtual

Open the window by showing the main panel.

The bark UI may conflict with the quest log window, so temporarily disable it.

Parameters

openedWindowHandler Opened window handler.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ Start()

virtual void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.Start ( )

virtual

Hide the main panel and all of the templates on start.

◆ Update()

void PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.Update ( )

Member Data Documentation

◆ abandonPopup

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.abandonPopup

The confirmation popup to use if the player clicks the abandon quest button.

It should send ClickConfirmAbandonQuest if the player confirms, or ClickCancelAbandonQuest if the player cancels.

◆ abandonQuestTitle

TMPro.TextMeshProUGUI PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.abandonQuestTitle

The quest title label to set in the abandon quest dialog popup.

◆ activeQuestsButton

UnityEngine.UI.Button PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.activeQuestsButton

The active quests button.

◆ animationTransitions

AnimationTransitions PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.animationTransitions = new AnimationTransitions()

◆ autoFocus

bool PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.autoFocus = false

Set true to always keep a control focused; useful for gamepads.

◆ completedQuestsButton

UnityEngine.UI.Button PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.completedQuestsButton

The completed quests button.

◆ mainPanel

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.mainPanel

The main quest log window panel.

◆ onContentChanged

UnityEvent PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.onContentChanged = new UnityEvent()

◆ questTable

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.questTable

The quest table.

◆ questTemplate

TextMeshProQuestTemplate PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProQuestLogWindow.questTemplate

The quest template.

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/TextMeshProQuestLogWindow.cs

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ ClickCancelAbandonQuestButton()

◆ ClickConfirmAbandonQuestButton()

◆ ClickQuestFoldout()

◆ CloseWindow()

◆ ConfirmAbandonQuest()

◆ NotifyContentChanged()

◆ OnQuestListUpdated()

◆ OpenWindow()

◆ Start()

◆ Update()

Member Data Documentation

◆ abandonPopup

◆ abandonQuestTitle

◆ activeQuestsButton

◆ animationTransitions

◆ autoFocus

◆ completedQuestsButton

◆ mainPanel

◆ onContentChanged

◆ questTable

◆ questTemplate