PixelCrushers.DialogueSystem.StandardUIDialogueControls Class Reference

Contains all dialogue (conversation) controls for a Standard Dialogue UI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIDialogueControls:

Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIDialogueControls:

Public Member Functions
void	Initialize ()
override void	SetActive (bool value)
override void	ShowPanel ()
void	ClosePanels ()
bool	AreAnyPanelsClosing (StandardUISubtitlePanel extraSubtitlePanel=null)
void	HideImmediate ()
void	OpenSubtitlePanelsOnStart (StandardDialogueUI ui)
void	ClearCaches ()
virtual void	ClearAllSubtitleText ()
virtual void	ClearSubtitleTextOnConversationStart ()
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUIControls
void	ShowPanel ()
	Shows the main conversation panel, if assigned.
override void	SetActive (bool value)
	Sets the conversation controls active/inactive.
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	SetActive (bool value)
	Sets the controls active/inactive.
void	Show ()
	Shows the controls by setting them active.
void	Hide ()
	Hides the controls by setting them inactive.

Public Attributes
UIPanel	mainPanel
bool	dontDeactivateMainPanel = false
bool	waitForMainPanelOpen = false
StandardUISubtitlePanel[]	subtitlePanels
StandardUISubtitlePanel	defaultNPCSubtitlePanel
StandardUISubtitlePanel	defaultPCSubtitlePanel
bool	allowOpenSubtitlePanelsOnStartConversation = true
bool	allowDialogueActorCustomPanels = true
StandardUIMenuPanel[]	menuPanels
StandardUIMenuPanel	defaultMenuPanel
bool	useFirstResponseForMenuPortrait
bool	waitForClose = true

Properties
StandardUISubtitleControls	standardSubtitleControls [get]
override AbstractUISubtitleControls	npcSubtitleControls [get]
override AbstractUISubtitleControls	pcSubtitleControls [get]
StandardUIResponseMenuControls	standardMenuControls [get]
override AbstractUIResponseMenuControls	responseMenuControls [get]
Properties inherited from PixelCrushers.DialogueSystem.AbstractDialogueUIControls
AbstractUISubtitleControls	npcSubtitleControls [get]
	Gets the NPC subtitle controls.
AbstractUISubtitleControls	pcSubtitleControls [get]
	Gets the PC subtitle controls.
AbstractUIResponseMenuControls	responseMenuControls [get]
	Gets the response menu.

Detailed Description

Contains all dialogue (conversation) controls for a Standard Dialogue UI.

Member Function Documentation

AreAnyPanelsClosing()

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.AreAnyPanelsClosing ( StandardUISubtitlePanel  extraSubtitlePanel = null )

inline

ClearAllSubtitleText()

virtual void PixelCrushers.DialogueSystem.StandardUIDialogueControls.ClearAllSubtitleText ( )

inlinevirtual

ClearCaches()

void PixelCrushers.DialogueSystem.StandardUIDialogueControls.ClearCaches ( )

inline

ClearSubtitleTextOnConversationStart()

virtual void PixelCrushers.DialogueSystem.StandardUIDialogueControls.ClearSubtitleTextOnConversationStart ( )

inlinevirtual

ClosePanels()

void PixelCrushers.DialogueSystem.StandardUIDialogueControls.ClosePanels ( )

inline

HideImmediate()

void PixelCrushers.DialogueSystem.StandardUIDialogueControls.HideImmediate ( )

inline

Initialize()

void PixelCrushers.DialogueSystem.StandardUIDialogueControls.Initialize ( )

inline

OpenSubtitlePanelsOnStart()

void PixelCrushers.DialogueSystem.StandardUIDialogueControls.OpenSubtitlePanelsOnStart ( StandardDialogueUI  ui )

inline

SetActive()

override void PixelCrushers.DialogueSystem.StandardUIDialogueControls.SetActive ( bool  value )

inline

ShowPanel()

override void PixelCrushers.DialogueSystem.StandardUIDialogueControls.ShowPanel ( )

inline

Member Data Documentation

allowDialogueActorCustomPanels

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.allowDialogueActorCustomPanels = true

allowOpenSubtitlePanelsOnStartConversation

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.allowOpenSubtitlePanelsOnStartConversation = true

defaultMenuPanel

StandardUIMenuPanel PixelCrushers.DialogueSystem.StandardUIDialogueControls.defaultMenuPanel

defaultNPCSubtitlePanel

StandardUISubtitlePanel PixelCrushers.DialogueSystem.StandardUIDialogueControls.defaultNPCSubtitlePanel

defaultPCSubtitlePanel

StandardUISubtitlePanel PixelCrushers.DialogueSystem.StandardUIDialogueControls.defaultPCSubtitlePanel

dontDeactivateMainPanel

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.dontDeactivateMainPanel = false

mainPanel

UIPanel PixelCrushers.DialogueSystem.StandardUIDialogueControls.mainPanel

menuPanels

StandardUIMenuPanel [] PixelCrushers.DialogueSystem.StandardUIDialogueControls.menuPanels

subtitlePanels

StandardUISubtitlePanel [] PixelCrushers.DialogueSystem.StandardUIDialogueControls.subtitlePanels

useFirstResponseForMenuPortrait

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.useFirstResponseForMenuPortrait

waitForClose

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.waitForClose = true

waitForMainPanelOpen

bool PixelCrushers.DialogueSystem.StandardUIDialogueControls.waitForMainPanelOpen = false

Property Documentation

npcSubtitleControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.StandardUIDialogueControls.npcSubtitleControls

get

pcSubtitleControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.StandardUIDialogueControls.pcSubtitleControls

get

responseMenuControls

override AbstractUIResponseMenuControls PixelCrushers.DialogueSystem.StandardUIDialogueControls.responseMenuControls

get

standardMenuControls

StandardUIResponseMenuControls PixelCrushers.DialogueSystem.StandardUIDialogueControls.standardMenuControls

get

standardSubtitleControls

StandardUISubtitleControls PixelCrushers.DialogueSystem.StandardUIDialogueControls.standardSubtitleControls

get

---

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