PixelCrushers.QuestMachine.UnityUIQuestAlertUI Class Reference

Unity UI implementation of QuestAlertUI. More...

Inheritance diagram for PixelCrushers.QuestMachine.UnityUIQuestAlertUI:

Collaboration diagram for PixelCrushers.QuestMachine.UnityUIQuestAlertUI:

Classes
struct	QueuedContent

Public Member Functions
override void	Show ()
virtual void	ShowAlert (string questID, List< QuestContent > contents)
	Shows a quest alert.
virtual void	ShowAlert (string message)
	Shows a quest alert.
void	ShowAlert (StringField stringField)
	Shows a quest alert.
Public Member Functions inherited from PixelCrushers.QuestMachine.UnityUIBaseUI
void	RefreshNavigableSelectables ()
virtual void	Hide ()

Protected Member Functions
override void	Awake ()
override void	AddContent (QuestContent content)
virtual IEnumerator	TimedDespawn (UnityUIContentTemplate instance, float duration)
float	GetDisplayDuration (List< QuestContent > contents)
float	GetDisplayDuration (QuestContent content)
float	GetDisplayDuration (StringField stringField)
virtual float	GetDisplayDuration (string text)
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	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
Coroutine	timedDespawnCoroutine = null
Queue< QueuedContent >	queuedAlerts = new Queue<QueuedContent>()

Properties
RectTransform	contentContainer [get, set]
UnityUIContainerTemplate	alertContainerTemplate [get, set]
UnityUITextTemplate	headingTemplate [get, set]
UnityUITextTemplate[]	subheadingTemplates [get, set]
UnityUITextTemplate	bodyTemplate [get, set]
UnityUIIconListTemplate	iconListTemplate [get, set]
UnityUIButtonListTemplate	buttonListTemplate [get, set]
bool	alwaysUseContainerTemplate [get, set]
bool	queueAlerts [get, set]
	Queue new alerts if an alert is already showing.
float	minDisplayDuration [get, set]
	Minimum duration in seconds to show alerts.
int	charsPerSecDuration [get, set]
	Duration to show alerts in characters per second.
bool	leaveLastContentVisibleDuringHide [get, set]
	When hiding after last content is done, leave last content visible during hide animation.
UnityEvent	onShowAlert [get]
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]
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]

Detailed Description

Unity UI implementation of QuestAlertUI.

Member Function Documentation

AddContent()

override void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.AddContent ( QuestContent  content )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

Awake()

override void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.Awake ( )

inlineprotectedvirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

GetDisplayDuration() [1/4]

float PixelCrushers.QuestMachine.UnityUIQuestAlertUI.GetDisplayDuration ( List< QuestContent >  contents )

inlineprotected

GetDisplayDuration() [2/4]

float PixelCrushers.QuestMachine.UnityUIQuestAlertUI.GetDisplayDuration ( QuestContent  content )

inlineprotected

GetDisplayDuration() [3/4]

virtual float PixelCrushers.QuestMachine.UnityUIQuestAlertUI.GetDisplayDuration ( string  text )

inlineprotectedvirtual

GetDisplayDuration() [4/4]

float PixelCrushers.QuestMachine.UnityUIQuestAlertUI.GetDisplayDuration ( StringField  stringField )

inlineprotected

Show()

override void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.Show ( )

inlinevirtual

Reimplemented from PixelCrushers.QuestMachine.UnityUIBaseUI.

ShowAlert() [1/3]

virtual void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.ShowAlert ( string  message )

inlinevirtual

Shows a quest alert.

Parameters

message

Alert to show.

Implements PixelCrushers.QuestMachine.IQuestAlertUI.

ShowAlert() [2/3]

virtual void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.ShowAlert ( string  questID, List< QuestContent >  contents  )

inlinevirtual

Shows a quest alert.

Parameters

questID	Quest ID.
contents	Complete quest alert content.

Implements PixelCrushers.QuestMachine.IQuestAlertUI.

ShowAlert() [3/3]

void PixelCrushers.QuestMachine.UnityUIQuestAlertUI.ShowAlert ( StringField  stringField )

inline

Shows a quest alert.

Parameters

stringField

Alert to show.

Implements PixelCrushers.QuestMachine.IQuestAlertUI.

TimedDespawn()

virtual IEnumerator PixelCrushers.QuestMachine.UnityUIQuestAlertUI.TimedDespawn ( UnityUIContentTemplate  instance, float  duration  )

inlineprotectedvirtual

Member Data Documentation

queuedAlerts

Queue<QueuedContent> PixelCrushers.QuestMachine.UnityUIQuestAlertUI.queuedAlerts = new Queue<QueuedContent>()

protected

timedDespawnCoroutine

Coroutine PixelCrushers.QuestMachine.UnityUIQuestAlertUI.timedDespawnCoroutine = null

protected

Property Documentation

alertContainerTemplate

UnityUIContainerTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.alertContainerTemplate

getset

alwaysUseContainerTemplate

bool PixelCrushers.QuestMachine.UnityUIQuestAlertUI.alwaysUseContainerTemplate

getset

bodyTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.bodyTemplate

getset

buttonListTemplate

UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.buttonListTemplate

getset

charsPerSecDuration

int PixelCrushers.QuestMachine.UnityUIQuestAlertUI.charsPerSecDuration

getset

Duration to show alerts in characters per second.

contentContainer

RectTransform PixelCrushers.QuestMachine.UnityUIQuestAlertUI.contentContainer

getset

contentManager

UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestAlertUI.contentManager

getsetprotected

currentBodyTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentBodyTemplate

getprotected

currentButtonListTemplate

override UnityUIButtonListTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentButtonListTemplate

getprotected

currentContentContainer

override RectTransform PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentContentContainer

getprotected

currentContentManager

override UnityUIInstancedContentManager PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentContentManager

getprotected

currentHeadingTemplate

override UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentHeadingTemplate

getprotected

currentIconListTemplate

override UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentIconListTemplate

getprotected

currentSubheadingTemplates

override UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestAlertUI.currentSubheadingTemplates

getprotected

headingTemplate

UnityUITextTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.headingTemplate

getset

iconListTemplate

UnityUIIconListTemplate PixelCrushers.QuestMachine.UnityUIQuestAlertUI.iconListTemplate

getset

leaveLastContentVisibleDuringHide

bool PixelCrushers.QuestMachine.UnityUIQuestAlertUI.leaveLastContentVisibleDuringHide

getset

When hiding after last content is done, leave last content visible during hide animation.

minDisplayDuration

float PixelCrushers.QuestMachine.UnityUIQuestAlertUI.minDisplayDuration

getset

Minimum duration in seconds to show alerts.

onShowAlert

UnityEvent PixelCrushers.QuestMachine.UnityUIQuestAlertUI.onShowAlert

get

queueAlerts

bool PixelCrushers.QuestMachine.UnityUIQuestAlertUI.queueAlerts

getset

Queue new alerts if an alert is already showing.

subheadingTemplates

UnityUITextTemplate [] PixelCrushers.QuestMachine.UnityUIQuestAlertUI.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 Alert UI/UnityUIQuestAlertUI.cs