PixelCrushers.QuestMachine.UnityUIQuestHUD Class Reference

Unity UI implementation of Quest HUD. More...

Inheritance diagram for PixelCrushers.QuestMachine.UnityUIQuestHUD:

Collaboration diagram for PixelCrushers.QuestMachine.UnityUIQuestHUD:

Public Member Functions
virtual void	SetVisibility (QuestListContainer questListContainer, bool value)
virtual void	Show (QuestListContainer questListContainer)
	Show the quest journal contents in the UI.
virtual void	Toggle (QuestListContainer questListContainer)
	Toggle the visibility of the UI.
virtual void	Repaint (QuestListContainer questListContainer)
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.
Public Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
void	RefreshNavigableSelectables ()
virtual void	Show ()
virtual void	Hide ()
Public Member Functions inherited from PixelCrushers.QuestMachine.IQuestHUD
void	Hide ()
	Hide the UI.

Protected Member Functions
override void	Awake ()
virtual void	OnDisable ()
virtual void	RefreshNow ()
virtual void	RefreshByGroup ()
virtual void	SortGroupNames (List< StringField > groups)
	You can override this method to sort differently.
virtual void	AddQuestsToContent (StringField group, bool showAll, bool showUngrouped)
virtual bool	ShouldBeVisible ()
virtual void	MakeInvisible ()
virtual void	MakeVisible ()
Protected Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
virtual void	InitializeTemplates ()
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 >	expandedGroupNames = new List<string>()
CanvasGroup	m_canvasGroup = null

Properties
RectTransform	contentContainer [get, set]
UnityUITextTemplate	questGroupTemplate [get, set]
UnityUITextTemplate	activeQuestHeadingTemplate [get, set]
UnityUITextTemplate	activeQuestBodyTemplate [get, set]
UnityUITextTemplate	completedQuestHeadingTemplate [get, set]
UnityUITextTemplate	completedQuestBodyTemplate [get, set]
UnityUIIconListTemplate	iconListTemplate [get, set]
UnityUIButtonListTemplate	buttonListTemplate [get, set]
UnityUITextTemplate[]	subheadingTemplates [get, set]
bool	showHUD [get, set]
bool	useGroups [get, set]
bool	showActiveQuests [get, set]
bool	showSuccessfulQuests [get, set]
bool	showFailedQuests [get, set]
bool	hideIfNoTrackedQuests [get, set]
bool	isQuestActive [get, set]
UnityUIInstancedContentManager	contentManager [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]
QuestListContainer	questListContainer [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.IQuestHUD
bool	isVisible [get]
	True if the HUD is visible, false otherwise.

Detailed Description

Unity UI implementation of Quest HUD.

Member Function Documentation

AddQuestsToContent()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.AddQuestsToContent ( StringField  group, bool  showAll, bool  showUngrouped  )

inlineprotectedvirtual

Awake()

override void PixelCrushers.QuestMachine.UnityUIQuestHUD.Awake ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

IsGroupExpanded()

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

inlinevirtual

True if the group is expanded in the UI.

Implements PixelCrushers.QuestMachine.IQuestHUD.

MakeInvisible()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.MakeInvisible ( )

inlineprotectedvirtual

MakeVisible()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.MakeVisible ( )

inlineprotectedvirtual

OnDisable()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.OnDisable ( )

inlineprotectedvirtual

RefreshByGroup()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.RefreshByGroup ( )

inlineprotectedvirtual

RefreshNow()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.RefreshNow ( )

inlineprotectedvirtual

Repaint()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.Repaint ( QuestListContainer  questListContainer )

inlinevirtual

Implements PixelCrushers.QuestMachine.IQuestHUD.

SetVisibility()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.SetVisibility ( QuestListContainer  questListContainer, bool  value  )

inlinevirtual

ShouldBeVisible()

virtual bool PixelCrushers.QuestMachine.UnityUIQuestHUD.ShouldBeVisible ( )

inlineprotectedvirtual

Show()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.Show ( QuestListContainer  questListContainer )

inlinevirtual

Show the quest journal contents in the UI.

Implements PixelCrushers.QuestMachine.IQuestHUD.

SortGroupNames()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.SortGroupNames ( List< StringField >  groups )

inlineprotectedvirtual

You can override this method to sort differently.

Toggle()

virtual void PixelCrushers.QuestMachine.UnityUIQuestHUD.Toggle ( QuestListContainer  questListContainer )

inlinevirtual

Toggle the visibility of the UI.

Implements PixelCrushers.QuestMachine.IQuestHUD.

ToggleGroup()

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

inlinevirtual

Toggles whether a group is expanded or not.

Parameters

groupName

Group to toggle.

Implements PixelCrushers.QuestMachine.IQuestHUD.

Member Data Documentation

expandedGroupNames

List<string> PixelCrushers.QuestMachine.UnityUIQuestHUD.expandedGroupNames = new List<string>()

protected

m_canvasGroup

CanvasGroup PixelCrushers.QuestMachine.UnityUIQuestHUD.m_canvasGroup = null

protected

Property Documentation

activeQuestBodyTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.activeQuestBodyTemplate

getset

activeQuestHeadingTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.activeQuestHeadingTemplate

getset

buttonListTemplate

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.buttonListTemplate

getset

completedQuestBodyTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.completedQuestBodyTemplate

getset

completedQuestHeadingTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.completedQuestHeadingTemplate

getset

contentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIQuestHUD.contentContainer

getset

contentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestHUD.contentManager

getsetprotected

currentBodyTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.currentBodyTemplate

getprotected

currentButtonListTemplate

override UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.currentButtonListTemplate

getprotected

currentContentContainer

override RectTransform PixelCrushers.QuestMachine.UnityUIQuestHUD.currentContentContainer

getprotected

currentContentManager

override UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestHUD.currentContentManager

getprotected

currentHeadingTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.currentHeadingTemplate

getprotected

currentIconListTemplate

override UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.currentIconListTemplate

getprotected

currentSubheadingTemplates

override UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestHUD.currentSubheadingTemplates

getprotected

hideIfNoTrackedQuests

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.hideIfNoTrackedQuests

getset

iconListTemplate

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.iconListTemplate

getset

isQuestActive

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.isQuestActive

getsetprotected

questGroupTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestHUD.questGroupTemplate

getset

questListContainer

QuestListContainer PixelCrushers.QuestMachine.UnityUIQuestHUD.questListContainer

getsetprotected

showActiveQuests

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.showActiveQuests

getset

showFailedQuests

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.showFailedQuests

getset

showHUD

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.showHUD

getset

showSuccessfulQuests

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.showSuccessfulQuests

getset

subheadingTemplates

UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestHUD.subheadingTemplates

getset

useGroups

bool PixelCrushers.QuestMachine.UnityUIQuestHUD.useGroups

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 HUD/UnityUIQuestHUD.cs