Unity UI implementation of Quest Journal UI. More...

Inheritance diagram for PixelCrushers.QuestMachine.UnityUIQuestJournalUI:

[legend]

Collaboration diagram for PixelCrushers.QuestMachine.UnityUIQuestJournalUI:

[legend]

Public Types
enum	SendMessageOnOpen { Never , Always , NotWhenUsingMouse }

Public Member Functions
virtual void	Toggle (QuestJournal questJournal)
	Toggle the visibility of the UI.

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	Show (QuestJournal questJournal)
	Opens the quest journal UI.

virtual void	Show (QuestJournal questJournal, Quest quest)
	Opens the quest journal UI, showing a specified quest's details.

virtual void	Show (QuestJournal questJournal, StringField questID)
	Opens the quest journal UI, showing a specified quest's details.

virtual void	Show (QuestJournal questJournal, string questID)
	Opens the quest journal UI, showing a specified quest's details.

override void	Hide ()

virtual void	Repaint (QuestJournal questJournal)
	Repaint the UI.

virtual void	Repaint ()

virtual void	SelectQuest (Quest quest)
	Selects a quest to show more details.

void	OnToggleTracking (bool value, object data)

void	ToggleTracking ()

void	OpenAbandonQuestConfirmationDialog ()

void	ConfirmAbandonQuest ()

Public Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
void	RefreshNavigableSelectables ()

virtual void	Show ()

Protected Member Functions
override void	Awake ()

virtual void	OnDisable ()

override void	InitializeTemplates ()

virtual Quest	GetFirstQuest ()

virtual void	RefreshNow ()

virtual void	RefreshHeading ()

virtual void	GetGroupNames (out List< string > groupNames, out int numGroupless)

virtual void	SortGroupNames (List< string > groupNames)
	You can override this method to sort differently.

virtual void	SortQuests (List< Quest > quests)
	You can override this method to sort differently.

virtual bool	IsCompletedQuestState (QuestState questState)

virtual void	AddQuestsToUI (List< string > groupNames, int numGroupless)

virtual void	AddGroupedQuestsToUI (List< Quest > quests, List< string > groupNames)

void	AddQuestGroupToUI (List< Quest > quests, string groupName)

virtual void	AddGrouplessQuestsToUI ()

virtual void	AddQuestsToUI (List< Quest > quests, string requiredGroupName, RectTransform container)

virtual void	AddQuestsToUI (List< Quest > quests, string requiredGroupName, RectTransform container, bool onlyAddActive)

virtual void	AddQuestToUI (Quest quest, RectTransform container)

virtual void	OnClickGroup (string groupName, UnityUIFoldoutTemplate groupFoldout)

virtual void	OnClickQuest (Quest quest)

virtual void	RepaintSelectedQuest ()

virtual List< QuestContent >	GetQuestContents (Quest quest)

Protected Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
virtual UnityUITextTemplate	GetHeadingTemplate (int level)

virtual void	SetContents (QuestParticipantTextInfo speaker, List< QuestContent > contents)

virtual void	SetContents (string displayName, Sprite image, List< QuestContent > contents)

virtual void	AddContents (List< QuestContent > contents)

virtual void	AddContent (QuestContent content)

virtual void	AddHeadingContent (HeadingTextQuestContent headingContent)

virtual void	AddBodyContent (BodyTextQuestContent bodyContent)

virtual void	AddBodyContent (string bodyContentString)

virtual void	AddIconContent (IconQuestContent iconContent)

virtual void	PrepareIconList ()

virtual UnityUIIconListTemplate	AddIconList ()

virtual void	AddButtonContent (ButtonQuestContent buttonContent)

virtual void	PrepareButtonList ()

virtual UnityUIButtonListTemplate	AddButtonList ()

virtual void	AddAudioContent (AudioClipQuestContent audioContent)

virtual void	AddGenericContent (QuestContent content)
	If you're defining new content types, you may want to override this method to handle your new content types specially.

virtual void	ClearContent ()

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

Properties
RectTransform	questSelectionContentContainer `[get, set]`

UnityUIFoldoutTemplate	questGroupTemplate `[get, set]`

UnityUIQuestNameButtonTemplate	activeQuestNameTemplate `[get, set]`

UnityUIQuestNameButtonTemplate	completedQuestNameTemplate `[get, set]`

bool	alwaysExpandAllGroups `[get, set]`

bool	showDetailsOnFocus `[get, set]`

bool	showTrackButtonInDetails `[get, set]`

bool	showCompletedQuests `[get, set]`

RectTransform	questDetailsContentContainer `[get, set]`

UnityUITextTemplate	questHeadingTextTemplate `[get, set]`

UnityUITextTemplate[]	subheadingTemplates `[get, set]`

UnityUITextTemplate	questBodyTextTemplate `[get, set]`

UnityUIIconListTemplate	iconListTemplate `[get, set]`

UnityUIButtonListTemplate	buttonListTemplate `[get, set]`

UnityUIButtonTemplate	trackButtonTemplate `[get, set]`

UnityUIButtonTemplate	abandonButtonTemplate `[get, set]`

UIPanel	abandonQuestPanel `[get, set]`

UITextField	abandonQuestNameText `[get, set]`

bool	showDisplayNameInHeading `[get, set]`

bool	showDialogueContentIfNoJournalContent `[get, set]`

bool	showOfferContentIfNoJournalOrDialogueContent `[get, set]`

bool	showQuestsThatHaveNoContent `[get, set]`

bool	showFirstQuestDetailsOnOpen `[get, set]`

UnityUIInstancedContentManager	selectionPanelContentManager `[get, set]`

UnityUIInstancedContentManager	detailsPanelContentManager `[get, set]`

bool	isDrawingSelectionPanel `[get, set]`

override RectTransform	currentContentContainer `[get]`

override UnityUIInstancedContentManager	currentContentManager `[get]`

override UnityUITextTemplate	currentHeadingTemplate `[get]`

override UnityUITextTemplate[]	currentSubheadingTemplates `[get]`

override UnityUITextTemplate	currentBodyTemplate `[get]`

override UnityUIIconListTemplate	currentIconListTemplate `[get]`

override UnityUIButtonListTemplate	currentButtonListTemplate `[get]`

Quest	selectedQuest `[get, set]`

QuestJournal	questJournal `[get, set]`

Properties inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
bool	isVisible `[get]`

RectTransform	mainPanel `[get, set]`

UITextField	entityName `[get, set]`

UnityEngine.UI.Image	entityImage `[get, set]`

UIPanel	uiPanel `[get, set]`

UnityUIIconListTemplate	currentIconList `[get, set]`

UnityUIButtonListTemplate	currentButtonList `[get, set]`

RectTransform	currentContentContainer `[get]`

UnityUIInstancedContentManager	currentContentManager `[get]`

UnityUITextTemplate	currentHeadingTemplate `[get]`

UnityUITextTemplate[]	currentSubheadingTemplates `[get]`

UnityUITextTemplate	currentBodyTemplate `[get]`

UnityUIIconListTemplate	currentIconListTemplate `[get]`

UnityUIButtonListTemplate	currentButtonListTemplate `[get]`

Properties inherited from PixelCrushers.QuestMachine.IQuestJournalUI
bool	isVisible `[get]`

Detailed Description

Unity UI implementation of Quest Journal UI.

Member Enumeration Documentation

◆ SendMessageOnOpen

enum PixelCrushers.QuestMachine.UnityUIQuestJournalUI.SendMessageOnOpen

Enumerator
Never
Always
NotWhenUsingMouse

Member Function Documentation

◆ AddGroupedQuestsToUI()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddGroupedQuestsToUI	(	List< Quest >	quests,
		List< string >	groupNames
	)

inlineprotectedvirtual

◆ AddGrouplessQuestsToUI()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddGrouplessQuestsToUI ( )

inlineprotectedvirtual

◆ AddQuestGroupToUI()

void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddQuestGroupToUI	(	List< Quest >	quests,
		string	groupName
	)

inlineprotected

◆ AddQuestsToUI() [1/3]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddQuestsToUI	(	List< Quest >	quests,
		string	requiredGroupName,
		RectTransform	container
	)

inlineprotectedvirtual

◆ AddQuestsToUI() [2/3]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddQuestsToUI	(	List< Quest >	quests,
		string	requiredGroupName,
		RectTransform	container,
		bool	onlyAddActive
	)

inlineprotectedvirtual

◆ AddQuestsToUI() [3/3]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddQuestsToUI	(	List< string >	groupNames,
		int	numGroupless
	)

inlineprotectedvirtual

◆ AddQuestToUI()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.AddQuestToUI	(	Quest	quest,
		RectTransform	container
	)

inlineprotectedvirtual

◆ Awake()

override void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Awake ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

◆ ConfirmAbandonQuest()

void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.ConfirmAbandonQuest ( )

inline

◆ GetFirstQuest()

virtual Quest PixelCrushers.QuestMachine.UnityUIQuestJournalUI.GetFirstQuest ( )

inlineprotectedvirtual

◆ GetGroupNames()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.GetGroupNames	(	out List< string >	groupNames,
		out int	numGroupless
	)

inlineprotectedvirtual

◆ GetQuestContents()

virtual List< QuestContent > PixelCrushers.QuestMachine.UnityUIQuestJournalUI.GetQuestContents ( Quest quest )

inlineprotectedvirtual

◆ Hide()

override void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Hide ( )

inlinevirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

◆ InitializeTemplates()

override void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.InitializeTemplates ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

◆ IsCompletedQuestState()

virtual bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.IsCompletedQuestState ( QuestState questState )

inlineprotectedvirtual

◆ IsGroupExpanded()

virtual bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.IsGroupExpanded ( string groupName )

inlinevirtual

True if the group is expanded in the UI.

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ OnClickGroup()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.OnClickGroup	(	string	groupName,
		UnityUIFoldoutTemplate	groupFoldout
	)

inlineprotectedvirtual

◆ OnClickQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.OnClickQuest ( Quest quest )

inlineprotectedvirtual

◆ OnDisable()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.OnDisable ( )

inlineprotectedvirtual

◆ OnToggleTracking()

void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.OnToggleTracking	(	bool	value,
		object	data
	)

inline

◆ OpenAbandonQuestConfirmationDialog()

void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.OpenAbandonQuestConfirmationDialog ( )

inline

◆ RefreshHeading()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.RefreshHeading ( )

inlineprotectedvirtual

◆ RefreshNow()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.RefreshNow ( )

inlineprotectedvirtual

◆ Repaint() [1/2]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Repaint ( )

inlinevirtual

◆ Repaint() [2/2]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Repaint ( QuestJournal questJournal )

inlinevirtual

Repaint the UI.

Parameters

questJournal

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ RepaintSelectedQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.RepaintSelectedQuest ( )

inlineprotectedvirtual

◆ SelectQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.SelectQuest ( Quest quest )

inlinevirtual

Selects a quest to show more details.

Parameters

quest The quest to select.

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ Show() [1/4]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Show ( QuestJournal questJournal )

inlinevirtual

Opens the quest journal UI.

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ Show() [2/4]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Show	(	QuestJournal	questJournal,
		Quest	quest
	)

inlinevirtual

Opens the quest journal UI, showing a specified quest's details.

◆ Show() [3/4]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Show	(	QuestJournal	questJournal,
		string	questID
	)

inlinevirtual

Opens the quest journal UI, showing a specified quest's details.

◆ Show() [4/4]

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Show	(	QuestJournal	questJournal,
		StringField	questID
	)

inlinevirtual

Opens the quest journal UI, showing a specified quest's details.

◆ SortGroupNames()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.SortGroupNames ( List< string > groupNames )

inlineprotectedvirtual

You can override this method to sort differently.

◆ SortQuests()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.SortQuests ( List< Quest > quests )

inlineprotectedvirtual

You can override this method to sort differently.

◆ Toggle()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.Toggle ( QuestJournal questJournal )

inlinevirtual

Toggle the visibility of the UI.

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ ToggleGroup()

virtual void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.ToggleGroup ( string groupName )

inlinevirtual

Toggles whether a group is expanded or not.

Parameters

groupName Group to toggle.

Implements PixelCrushers.QuestMachine.IQuestJournalUI.

◆ ToggleTracking()

void PixelCrushers.QuestMachine.UnityUIQuestJournalUI.ToggleTracking ( )

inline

Member Data Documentation

◆ collapsedGroupNames

List<string> PixelCrushers.QuestMachine.UnityUIQuestJournalUI.collapsedGroupNames = new List<string>()

protected

Property Documentation

◆ abandonButtonTemplate

UnityUIButtonTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.abandonButtonTemplate

getset

◆ abandonQuestNameText

UITextField PixelCrushers.QuestMachine.UnityUIQuestJournalUI.abandonQuestNameText

getset

◆ abandonQuestPanel

UIPanel PixelCrushers.QuestMachine.UnityUIQuestJournalUI.abandonQuestPanel

getset

◆ activeQuestNameTemplate

UnityUIQuestNameButtonTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.activeQuestNameTemplate

getset

◆ alwaysExpandAllGroups

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.alwaysExpandAllGroups

getset

◆ buttonListTemplate

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.buttonListTemplate

getset

◆ completedQuestNameTemplate

UnityUIQuestNameButtonTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.completedQuestNameTemplate

getset

◆ currentBodyTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentBodyTemplate

getprotected

◆ currentButtonListTemplate

override UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentButtonListTemplate

getprotected

◆ currentContentContainer

override RectTransform PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentContentContainer

getprotected

◆ currentContentManager

override UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentContentManager

getprotected

◆ currentHeadingTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentHeadingTemplate

getprotected

◆ currentIconListTemplate

override UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentIconListTemplate

getprotected

◆ currentSubheadingTemplates

override UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestJournalUI.currentSubheadingTemplates

getprotected

◆ detailsPanelContentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestJournalUI.detailsPanelContentManager

getsetprotected

◆ iconListTemplate

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.iconListTemplate

getset

◆ isDrawingSelectionPanel

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.isDrawingSelectionPanel

getsetprotected

◆ questBodyTextTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questBodyTextTemplate

getset

◆ questDetailsContentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questDetailsContentContainer

getset

◆ questGroupTemplate

UnityUIFoldoutTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questGroupTemplate

getset

◆ questHeadingTextTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questHeadingTextTemplate

getset

◆ questJournal

QuestJournal PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questJournal

getsetprotected

◆ questSelectionContentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIQuestJournalUI.questSelectionContentContainer

getset

◆ selectedQuest

Quest PixelCrushers.QuestMachine.UnityUIQuestJournalUI.selectedQuest

getsetprotected

◆ selectionPanelContentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestJournalUI.selectionPanelContentManager

getsetprotected

◆ showCompletedQuests

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showCompletedQuests

getset

◆ showDetailsOnFocus

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showDetailsOnFocus

getset

◆ showDialogueContentIfNoJournalContent

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showDialogueContentIfNoJournalContent

getset

◆ showDisplayNameInHeading

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showDisplayNameInHeading

getset

◆ showFirstQuestDetailsOnOpen

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showFirstQuestDetailsOnOpen

getset

◆ showOfferContentIfNoJournalOrDialogueContent

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showOfferContentIfNoJournalOrDialogueContent

getset

◆ showQuestsThatHaveNoContent

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showQuestsThatHaveNoContent

getset

◆ showTrackButtonInDetails

bool PixelCrushers.QuestMachine.UnityUIQuestJournalUI.showTrackButtonInDetails

getset

◆ subheadingTemplates

UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestJournalUI.subheadingTemplates

getset

◆ trackButtonTemplate

UnityUIButtonTemplate PixelCrushers.QuestMachine.UnityUIQuestJournalUI.trackButtonTemplate

getset

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 UIs/Unity UI/Unity UI Quest Journal UI/UnityUIQuestJournalUI.cs

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ SendMessageOnOpen

Member Function Documentation

◆ AddGroupedQuestsToUI()

◆ AddGrouplessQuestsToUI()

◆ AddQuestGroupToUI()

◆ AddQuestsToUI() [1/3]

◆ AddQuestsToUI() [2/3]

◆ AddQuestsToUI() [3/3]

◆ AddQuestToUI()

◆ Awake()

◆ ConfirmAbandonQuest()

◆ GetFirstQuest()

◆ GetGroupNames()

◆ GetQuestContents()

◆ Hide()

◆ InitializeTemplates()

◆ IsCompletedQuestState()

◆ IsGroupExpanded()

◆ OnClickGroup()

◆ OnClickQuest()

◆ OnDisable()

◆ OnToggleTracking()

◆ OpenAbandonQuestConfirmationDialog()

◆ RefreshHeading()

◆ RefreshNow()

◆ Repaint() [1/2]

◆ Repaint() [2/2]

◆ RepaintSelectedQuest()

◆ SelectQuest()

◆ Show() [1/4]

◆ Show() [2/4]

◆ Show() [3/4]

◆ Show() [4/4]

◆ SortGroupNames()

◆ SortQuests()

◆ Toggle()

◆ ToggleGroup()

◆ ToggleTracking()

Member Data Documentation

◆ collapsedGroupNames

Property Documentation

◆ abandonButtonTemplate

◆ abandonQuestNameText

◆ abandonQuestPanel

◆ activeQuestNameTemplate

◆ alwaysExpandAllGroups

◆ buttonListTemplate

◆ completedQuestNameTemplate

◆ currentBodyTemplate

◆ currentButtonListTemplate

◆ currentContentContainer

◆ currentContentManager

◆ currentHeadingTemplate

◆ currentIconListTemplate

◆ currentSubheadingTemplates

◆ detailsPanelContentManager

◆ iconListTemplate

◆ isDrawingSelectionPanel

◆ questBodyTextTemplate

◆ questDetailsContentContainer

◆ questGroupTemplate

◆ questHeadingTextTemplate

◆ questJournal

◆ questSelectionContentContainer

◆ selectedQuest

◆ selectionPanelContentManager

◆ showCompletedQuests

◆ showDetailsOnFocus

◆ showDialogueContentIfNoJournalContent

◆ showDisplayNameInHeading

◆ showFirstQuestDetailsOnOpen

◆ showOfferContentIfNoJournalOrDialogueContent

◆ showQuestsThatHaveNoContent