PixelCrushers.QuestMachine.UnityUIQuestDialogueUI Class Reference

Unity UI implementation of QuestDialogueUI. More...

Inheritance diagram for PixelCrushers.QuestMachine.UnityUIQuestDialogueUI:

Collaboration diagram for PixelCrushers.QuestMachine.UnityUIQuestDialogueUI:

Public Member Functions
virtual void	ShowContents (QuestParticipantTextInfo speaker, List< QuestContent > contents)
	Shows UI content.
virtual void	ShowOfferConditionsUnmet (QuestParticipantTextInfo speaker, List< QuestContent > contents, List< Quest > quests)
	Shows content explaining that all quests' offer conditions are unmet.
virtual void	ShowOfferQuest (QuestParticipantTextInfo speaker, Quest quest, QuestParameterDelegate acceptHandler, QuestParameterDelegate declineHandler)
	Shows a quest offer.
void	AcceptQuest ()
void	DeclineQuest ()
void	Back ()
void	SetBackHandler (QuestParameterDelegate backHandler)
virtual void	ShowActiveQuest (QuestParticipantTextInfo speaker, Quest quest, QuestParameterDelegate continueHandler, QuestParameterDelegate backHandler)
	Shows an active quest.
virtual void	ShowCompletedQuest (QuestParticipantTextInfo speaker, List< Quest > quests)
	Shows completed quests.
virtual void	ShowQuestList (QuestParticipantTextInfo speaker, List< QuestContent > activeQuestsContents, List< Quest > activeQuests, List< QuestContent > offerableQuestsContents, List< Quest > offerableQuests, QuestParameterDelegate selectHandler)
	Shows a list of quests.
void	AddQuestList (List< QuestContent > contents, List< Quest > quests, QuestParameterDelegate selectHandler)
void	OnMessage (MessageArgs messageArgs)
	Handles a message that the message handler is listening for.
Public Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
void	RefreshNavigableSelectables ()
virtual void	Show ()
virtual void	Hide ()
Public Member Functions inherited from PixelCrushers.QuestMachine.IQuestDialogueUI
void	Hide ()
	Hides the dialogue UI.

Protected Member Functions
override void	Awake ()
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual bool	ContainsGroupButton (List< QuestContent > contents)
virtual void	SetControlButtons (bool enableClose, bool enableBack, bool enableAcceptDecline)
virtual void	SetControlButtonsInteractable (bool value)
IEnumerator	SelectAfterOneFrame (UnityEngine.UI.Selectable selectable)
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 ()

Properties
UnityEngine.UI.Button	cancelButton [get, set]
UnityEngine.UI.Button	closeButton [get, set]
UnityEngine.UI.Button	backButton [get, set]
UnityEngine.UI.Button	acceptButton [get, set]
UnityEngine.UI.Button	declineButton [get, set]
RectTransform	contentContainer [get, set]
UnityUITextTemplate	headingTemplate [get, set]
UnityUITextTemplate[]	subheadingTemplates [get, set]
UnityUITextTemplate	bodyTemplate [get, set]
UnityUIIconListTemplate	iconListTemplate [get, set]
UnityUIButtonListTemplate	buttonListTemplate [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]
UIScrollbarEnabler	scrollbarEnabler [get, set]
Quest	selectedQuest [get, set]
QuestParameterDelegate	acceptHandler [get, set]
QuestParameterDelegate	declineHandler [get, set]
QuestParameterDelegate	backHandler [get, set]
Coroutine	selectCoroutine [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.IQuestDialogueUI
bool	isVisible [get]
	True if the dialogue UI is visible, false otherwise.

Detailed Description

Unity UI implementation of QuestDialogueUI.

Member Function Documentation

AcceptQuest()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.AcceptQuest ( )

inline

AddQuestList()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.AddQuestList ( List< QuestContent >  contents, List< Quest >  quests, QuestParameterDelegate  selectHandler  )

inline

Awake()

override void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.Awake ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

Back()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.Back ( )

inline

ContainsGroupButton()

virtual bool PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ContainsGroupButton ( List< QuestContent >  contents )

inlineprotectedvirtual

DeclineQuest()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.DeclineQuest ( )

inline

OnDisable()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.OnDisable ( )

inlineprotectedvirtual

OnEnable()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.OnEnable ( )

inlineprotectedvirtual

OnMessage()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.OnMessage ( MessageArgs  messageArgs )

inline

Handles a message that the message handler is listening for.

Parameters

messageArgs

The message that was sent to the MessageSystem.

Implements PixelCrushers.IMessageHandler.

SelectAfterOneFrame()

IEnumerator PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.SelectAfterOneFrame ( UnityEngine::UI::Selectable  selectable )

inlineprotected

SetBackHandler()

void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.SetBackHandler ( QuestParameterDelegate  backHandler )

inline

SetControlButtons()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.SetControlButtons ( bool  enableClose, bool  enableBack, bool  enableAcceptDecline  )

inlineprotectedvirtual

SetControlButtonsInteractable()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.SetControlButtonsInteractable ( bool  value )

inlineprotectedvirtual

ShowActiveQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowActiveQuest ( QuestParticipantTextInfo  speaker, Quest  quest, QuestParameterDelegate  continueHandler, QuestParameterDelegate  backHandler  )

inlinevirtual

Shows an active quest.

Parameters

speaker	Speaker.
quest	Active quest.
continueHandler	Method to invoke if the player clicks the continue button.
backHandler	Method to invoke if the player clicks the back button.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

ShowCompletedQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowCompletedQuest ( QuestParticipantTextInfo  speaker, List< Quest >  quests  )

inlinevirtual

Shows completed quests.

Parameters

speaker	Speaker
quests	Completed quests.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

ShowContents()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowContents ( QuestParticipantTextInfo  speaker, List< QuestContent >  contents  )

inlinevirtual

Shows UI content.

Parameters

speaker	Speaker.
contents	Content being spoken by speaker.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

ShowOfferConditionsUnmet()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowOfferConditionsUnmet ( QuestParticipantTextInfo  speaker, List< QuestContent >  contents, List< Quest >  quests  )

inlinevirtual

Shows content explaining that all quests' offer conditions are unmet.

Parameters

speaker	Speaker.
contents	Content explaining that all quests' offer conditions are unmet.
quests	List of quests.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

ShowOfferQuest()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowOfferQuest ( QuestParticipantTextInfo  speaker, Quest  quest, QuestParameterDelegate  acceptHandler, QuestParameterDelegate  declineHandler  )

inlinevirtual

Shows a quest offer.

Parameters

speaker	Speaker.
quest	Quest to offer.
acceptHandler	Method to invoke if the player accepts the quest.
declineHandler	Method to invoke if the player declines the quest.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

ShowQuestList()

virtual void PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.ShowQuestList ( QuestParticipantTextInfo  speaker, List< QuestContent >  activeQuestsContents, List< Quest >  activeQuests, List< QuestContent >  offerableQuestsContents, List< Quest >  offerableQuests, QuestParameterDelegate  selectHandler  )

inlinevirtual

Shows a list of quests.

Parameters

speaker	Speaker.
activeQuestsContents	Content introducing the list of active quests.
activeQuests	Active quests.
offerableQuestsContents	Content introducing the list of offerable quests.
offerableQuests	Offerable quests.
selectHandler	Method to invoke when the player selects a quest.

Implements PixelCrushers.QuestMachine.IQuestDialogueUI.

Property Documentation

acceptButton

UnityEngine.UI.Button PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.acceptButton

getset

acceptHandler

QuestParameterDelegate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.acceptHandler

getsetprotected

backButton

UnityEngine.UI.Button PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.backButton

getset

backHandler

QuestParameterDelegate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.backHandler

getsetprotected

bodyTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.bodyTemplate

getset

buttonListTemplate

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.buttonListTemplate

getset

cancelButton

UnityEngine.UI.Button PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.cancelButton

getset

closeButton

UnityEngine.UI.Button PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.closeButton

getset

contentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.contentContainer

getset

contentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.contentManager

getsetprotected

currentBodyTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentBodyTemplate

getprotected

currentButtonListTemplate

override UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentButtonListTemplate

getprotected

currentContentContainer

override RectTransform PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentContentContainer

getprotected

currentContentManager

override UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentContentManager

getprotected

currentHeadingTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentHeadingTemplate

getprotected

currentIconListTemplate

override UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentIconListTemplate

getprotected

currentSubheadingTemplates

override UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.currentSubheadingTemplates

getprotected

declineButton

UnityEngine.UI.Button PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.declineButton

getset

declineHandler

QuestParameterDelegate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.declineHandler

getsetprotected

headingTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.headingTemplate

getset

iconListTemplate

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.iconListTemplate

getset

scrollbarEnabler

UIScrollbarEnabler PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.scrollbarEnabler

getsetprotected

selectCoroutine

Coroutine PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.selectCoroutine

getsetprotected

selectedQuest

Quest PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.selectedQuest

getsetprotected

subheadingTemplates

UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestDialogueUI.subheadingTemplates

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 Dialogue UI/UnityUIQuestDialogueUI.cs