Public Member Functions | Public Attributes | Properties | List of all members
PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls Class Reference

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

Inheritance diagram for PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls:
Collaboration graph
[legend]

Public Member Functions

override void ShowPanel ()
 
override void SetActive (bool value)
 
void SetPortraitCollection (tk2dSpriteCollectionData portraitCollection)
 Sets the sprite collection to use for portrait images.
 
- 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

tk2dUILayout panel
 The alert panel.
 
TK2DSubtitleControls npcSubtitle
 The NPC subtitle controls.
 
TK2DSubtitleControls pcSubtitle
 The PC subtitle controls.
 
TK2DResponseMenuControls responseMenu
 The response menu controls.
 

Properties

override AbstractUISubtitleControls npcSubtitleControls [get]
 
override AbstractUISubtitleControls pcSubtitleControls [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 TK2D Dialogue UI.

Member Function Documentation

◆ SetActive()

override void PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.SetActive ( bool  value)
inline

◆ SetPortraitCollection()

void PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.SetPortraitCollection ( tk2dSpriteCollectionData  portraitCollection)
inline

Sets the sprite collection to use for portrait images.

Parameters
portraitCollectionPortrait collection.

◆ ShowPanel()

override void PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.ShowPanel ( )
inline

Member Data Documentation

◆ npcSubtitle

TK2DSubtitleControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.npcSubtitle

The NPC subtitle controls.

◆ panel

tk2dUILayout PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.panel

The alert panel.

A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.

◆ pcSubtitle

TK2DSubtitleControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.pcSubtitle

The PC subtitle controls.

◆ responseMenu

TK2DResponseMenuControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.responseMenu

The response menu controls.

Property Documentation

◆ npcSubtitleControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.npcSubtitleControls
get

◆ pcSubtitleControls

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.pcSubtitleControls
get

◆ responseMenuControls

override AbstractUIResponseMenuControls PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueControls.responseMenuControls
get
The documentation for this class was generated from the following file: