This is the Standard UI implementation of the abstract QuestLogWindow class. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIQuestLogWindow:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIQuestLogWindow:

[legend]

Public Member Functions
override void	Awake ()

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

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

virtual void	Toggle ()

virtual bool	IsGroupExpanded (string groupName)
	True if the group is expanded in the UI.

virtual void	ToggleGroup (string groupName)
	Toggles whether a group is expanded or not.

virtual void	Repaint ()

override void	OnQuestListUpdated ()
	Called when the quest list has been updated – for example, when switching between active and completed quests.

virtual void	SelectQuest (string questTitle)

virtual void	OnToggleTracking (bool value, object data)
	Toggles quest tracking.

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

virtual void	AbandonQuestConfirmed ()

Public Member Functions inherited from PixelCrushers.DialogueSystem.QuestLogWindow
virtual void	OpenWindow (Action openedWindowHandler)
	Opens the window.

virtual void	CloseWindow (Action closedWindowHandler)
	Closes the window.

virtual void	ConfirmAbandonQuest (string title, Action confirmedAbandonQuestHandler)
	Asks the player to confirm abandonment of a quest.

virtual void	Open ()
	Opens the quest window.

virtual void	Close ()
	Closes the quest log window.

virtual bool	IsQuestVisible (string questTitle)

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

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

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

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

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

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

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

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

virtual void	ClickShowActiveQuestsButton ()

void	ClickShowCompletedQuestsButton ()

void	ClickCloseButton ()

void	ClickAbandonQuestButton ()

void	ClickTrackQuestButton ()

void	UpdateTracker ()

Public Attributes
UIPanel	mainPanel

UITextField	showingActiveQuestsHeading

UITextField	showingCompletedQuestHeading

UnityEngine.UI.Button	activeQuestsButton

UnityEngine.UI.Button	completedQuestsButton

RectTransform	questSelectionContentContainer

StandardUIFoldoutTemplate	questGroupTemplate

StandardUIQuestTitleButtonTemplate	activeQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate	selectedActiveQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate	completedQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate	selectedCompletedQuestHeadingTemplate

bool	showNoQuestsText = true

bool	selectFirstQuestOnOpen = false

bool	showDetailsOnSelect = false

bool	keepGroupsExpanded = false

RectTransform	questDetailsContentContainer

StandardUITextTemplate	questHeadingTextTemplate

StandardUITextTemplate	questDescriptionTextTemplate

StandardUITextTemplate	questEntryActiveTextTemplate

StandardUITextTemplate	questEntrySuccessTextTemplate

StandardUITextTemplate	questEntryFailureTextTemplate

StandardUIButtonTemplate	abandonButtonTemplate

UIPanel	abandonQuestPanel

UITextField	abandonQuestTitleText

UnityEvent	onOpen = new UnityEvent()

UnityEvent	onClose = new UnityEvent()

bool	addEventSystemIfNeeded = true

string	foldoutToSelect = null

string	questTitleToSelect = null

Public Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
TextTable	textTable = null

string	noActiveQuestsText = "No Active Quests"

string	noCompletedQuestsText = "No Completed Quests"

bool	checkVisibleField = false

QuestHeadingSource	questHeadingSource = QuestHeadingSource.Name
	The quest title source.

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

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

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

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

string	newQuestText = string.Empty

bool	trackOneQuestAtATime = false

bool	deselectQuestOnSecondClick = true

Protected Member Functions
virtual void	InitializeTemplates ()

void	SetStateToggleButtons ()

virtual StandardUIQuestTitleButtonTemplate	GetQuestTitleTemplate (QuestInfo quest)

virtual StandardUIQuestTitleButtonTemplate	GetSelectedQuestTitleTemplate (QuestInfo quest)

IEnumerator	SelectElement (UnityEngine.UI.Selectable elementToSelect)

virtual void	AddShowDetailsOnSelect (UnityEngine.UI.Button button, string target)

virtual void	OnClickGroup (string groupName, StandardUIFoldoutTemplate groupFoldout)

virtual void	ShowDetailsOnSelect (string questTitle)

virtual void	OnClickQuest (string questTitle)

virtual void	RepaintSelectedQuest (QuestInfo quest)

virtual StandardUITextTemplate	GetEntryTemplate (QuestState state)

override void	ShowQuests (QuestState questStateMask)

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

virtual void	OnEnable ()

virtual void	OnDisable ()

void	RegisterForUpdateTrackerEvents ()

void	UnregisterFromUpdateTrackerEvents ()

virtual void	OnOpenedWindow ()

virtual void	OnClosedWindow ()

virtual void	PauseGameplay ()

virtual void	ResumeGameplay ()

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

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

IEnumerator	UpdateQuestDisplayAtEndOfFrame ()

Protected Attributes
List< string >	expandedGroupNames = new List<string>()

System.Action	confirmAbandonQuestHandler = null

string	mostRecentSelectedActiveQuest = null

string	mostRecentSelectedCompletedQuest = null

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

float	previousTimeScale = 1
	The previous time scale prior to opening the window.

Coroutine	refreshCoroutine = null

bool	started = false

Properties
StandardUIInstancedContentManager	selectionPanelContentManager `[get, set]`

StandardUIInstancedContentManager	detailsPanelContentManager `[get, set]`

UnityEngine.EventSystems.EventSystem	eventSystem `[get, set]`

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

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

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

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

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

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

Properties inherited from PixelCrushers.IEventSystemUser

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

Static Protected Attributes inherited from PixelCrushers.DialogueSystem.QuestLogWindow
const QuestState	ActiveQuestStateMask = QuestState.Active \| QuestState.ReturnToNPC

Detailed Description

This is the Standard UI implementation of the abstract QuestLogWindow class.

Member Function Documentation

◆ AbandonQuestConfirmed()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.AbandonQuestConfirmed ( )

inlinevirtual

◆ AddShowDetailsOnSelect()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.AddShowDetailsOnSelect	(	UnityEngine::UI::Button	button,
		string	target
	)

inlineprotectedvirtual

◆ Awake()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.Awake ( )

inlinevirtual

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ CloseWindow()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.CloseWindow ( System::Action closedWindowHandler )

inline

Close the window by hiding the main panel.

Re-enable the bark UI.

Parameters

closedWindowHandler Closed window handler.

◆ ConfirmAbandonQuest()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.ConfirmAbandonQuest	(	string	title,
		System::Action	confirmAbandonQuestHandler
	)

inline

Opens the abandon confirmation popup.

Parameters

title	Quest title.
confirmAbandonQuestHandler	Confirm abandon quest handler.

◆ GetEntryTemplate()

virtual StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.GetEntryTemplate ( QuestState state )

inlineprotectedvirtual

◆ GetQuestTitleTemplate()

virtual StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.GetQuestTitleTemplate ( QuestInfo quest )

inlineprotectedvirtual

◆ GetSelectedQuestTitleTemplate()

virtual StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.GetSelectedQuestTitleTemplate ( QuestInfo quest )

inlineprotectedvirtual

◆ InitializeTemplates()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.InitializeTemplates ( )

inlineprotectedvirtual

◆ IsGroupExpanded()

virtual bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.IsGroupExpanded ( string groupName )

inlinevirtual

True if the group is expanded in the UI.

◆ OnClickGroup()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.OnClickGroup	(	string	groupName,
		StandardUIFoldoutTemplate	groupFoldout
	)

inlineprotectedvirtual

◆ OnClickQuest()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.OnClickQuest ( string questTitle )

inlineprotectedvirtual

◆ OnQuestListUpdated()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.OnQuestListUpdated ( )

inlinevirtual

Called when the quest list has been updated – for example, when switching between active and completed quests.

Your implementation may override this to do processing.

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ OnToggleTracking()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.OnToggleTracking	(	bool	value,
		object	data
	)

inlinevirtual

Toggles quest tracking.

Parameters

value	Tracking on or off.
data	Quest name (string).

◆ OpenWindow()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.OpenWindow ( System::Action openedWindowHandler )

inline

Open the window by showing the main panel.

Parameters

openedWindowHandler Opened window handler.

◆ Repaint()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.Repaint ( )

inlinevirtual

◆ RepaintSelectedQuest()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.RepaintSelectedQuest ( QuestInfo quest )

inlineprotectedvirtual

◆ SelectElement()

IEnumerator PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.SelectElement ( UnityEngine::UI::Selectable elementToSelect )

inlineprotected

◆ SelectQuest()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.SelectQuest ( string questTitle )

inlinevirtual

◆ SetStateToggleButtons()

void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.SetStateToggleButtons ( )

inlineprotected

◆ ShowDetailsOnSelect()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.ShowDetailsOnSelect ( string questTitle )

inlineprotectedvirtual

◆ ShowQuests()

override void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.ShowQuests ( QuestState questStateMask )

inlineprotectedvirtual

Reimplemented from PixelCrushers.DialogueSystem.QuestLogWindow.

◆ Toggle()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.Toggle ( )

inlinevirtual

◆ ToggleGroup()

virtual void PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.ToggleGroup ( string groupName )

inlinevirtual

Toggles whether a group is expanded or not.

Parameters

groupName Group to toggle.

Member Data Documentation

◆ abandonButtonTemplate

StandardUIButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.abandonButtonTemplate

◆ abandonQuestPanel

UIPanel PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.abandonQuestPanel

◆ abandonQuestTitleText

UITextField PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.abandonQuestTitleText

◆ activeQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.activeQuestHeadingTemplate

◆ activeQuestsButton

UnityEngine.UI.Button PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.activeQuestsButton

◆ addEventSystemIfNeeded

bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.addEventSystemIfNeeded = true

◆ completedQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.completedQuestHeadingTemplate

◆ completedQuestsButton

UnityEngine.UI.Button PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.completedQuestsButton

◆ confirmAbandonQuestHandler

System.Action PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.confirmAbandonQuestHandler = null

protected

◆ expandedGroupNames

List<string> PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.expandedGroupNames = new List<string>()

protected

◆ foldoutToSelect

string PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.foldoutToSelect = null

◆ keepGroupsExpanded

bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.keepGroupsExpanded = false

◆ mainPanel

UIPanel PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.mainPanel

◆ mostRecentSelectedActiveQuest

string PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.mostRecentSelectedActiveQuest = null

protected

◆ mostRecentSelectedCompletedQuest

string PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.mostRecentSelectedCompletedQuest = null

protected

◆ onClose

UnityEvent PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.onClose = new UnityEvent()

◆ onOpen

UnityEvent PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.onOpen = new UnityEvent()

◆ questDescriptionTextTemplate

StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questDescriptionTextTemplate

◆ questDetailsContentContainer

RectTransform PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questDetailsContentContainer

◆ questEntryActiveTextTemplate

StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questEntryActiveTextTemplate

◆ questEntryFailureTextTemplate

StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questEntryFailureTextTemplate

◆ questEntrySuccessTextTemplate

StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questEntrySuccessTextTemplate

◆ questGroupTemplate

StandardUIFoldoutTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questGroupTemplate

◆ questHeadingTextTemplate

StandardUITextTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questHeadingTextTemplate

◆ questSelectionContentContainer

RectTransform PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questSelectionContentContainer

◆ questTitleToSelect

string PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.questTitleToSelect = null

◆ selectedActiveQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.selectedActiveQuestHeadingTemplate

◆ selectedCompletedQuestHeadingTemplate

StandardUIQuestTitleButtonTemplate PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.selectedCompletedQuestHeadingTemplate

◆ selectFirstQuestOnOpen

bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.selectFirstQuestOnOpen = false

◆ showDetailsOnSelect

bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.showDetailsOnSelect = false

◆ showingActiveQuestsHeading

UITextField PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.showingActiveQuestsHeading

◆ showingCompletedQuestHeading

UITextField PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.showingCompletedQuestHeading

◆ showNoQuestsText

bool PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.showNoQuestsText = true

Property Documentation

◆ detailsPanelContentManager

StandardUIInstancedContentManager PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.detailsPanelContentManager

getsetprotected

◆ eventSystem

UnityEngine.EventSystems.EventSystem PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.eventSystem

getset

Implements PixelCrushers.IEventSystemUser.

◆ selectionPanelContentManager

StandardUIInstancedContentManager PixelCrushers.DialogueSystem.StandardUIQuestLogWindow.selectionPanelContentManager

getsetprotected

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

C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Standard/Quest/StandardUIQuestLogWindow.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AbandonQuestConfirmed()

◆ AddShowDetailsOnSelect()

◆ Awake()

◆ CloseWindow()

◆ ConfirmAbandonQuest()

◆ GetEntryTemplate()

◆ GetQuestTitleTemplate()

◆ GetSelectedQuestTitleTemplate()

◆ InitializeTemplates()

◆ IsGroupExpanded()

◆ OnClickGroup()

◆ OnClickQuest()

◆ OnQuestListUpdated()

◆ OnToggleTracking()

◆ OpenWindow()

◆ Repaint()

◆ RepaintSelectedQuest()

◆ SelectElement()

◆ SelectQuest()

◆ SetStateToggleButtons()

◆ ShowDetailsOnSelect()

◆ ShowQuests()

◆ Toggle()

◆ ToggleGroup()

Member Data Documentation

◆ abandonButtonTemplate

◆ abandonQuestPanel

◆ abandonQuestTitleText

◆ activeQuestHeadingTemplate

◆ activeQuestsButton

◆ addEventSystemIfNeeded

◆ completedQuestHeadingTemplate

◆ completedQuestsButton

◆ confirmAbandonQuestHandler

◆ expandedGroupNames

◆ foldoutToSelect

◆ keepGroupsExpanded

◆ mainPanel

◆ mostRecentSelectedActiveQuest

◆ mostRecentSelectedCompletedQuest

◆ onClose

◆ onOpen

◆ questDescriptionTextTemplate

◆ questDetailsContentContainer

◆ questEntryActiveTextTemplate

◆ questEntryFailureTextTemplate

◆ questEntrySuccessTextTemplate

◆ questGroupTemplate

◆ questHeadingTextTemplate

◆ questSelectionContentContainer

◆ questTitleToSelect

◆ selectedActiveQuestHeadingTemplate

◆ selectedCompletedQuestHeadingTemplate

◆ selectFirstQuestOnOpen

◆ showDetailsOnSelect

◆ showingActiveQuestsHeading

◆ showingCompletedQuestHeading

◆ showNoQuestsText

Property Documentation

◆ detailsPanelContentManager

◆ eventSystem

◆ selectionPanelContentManager