PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls Class Reference

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

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls:
Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls:

Public Member Functions

override void ShowPanel ()
 Shows the main conversation panel, if assigned. More...
 
override void SetActive (bool value)
 Sets the conversation controls active/inactive. More...
 
void SetPortraitCollection (tk2dSpriteCollectionData portraitCollection)
 Sets the sprite collection to use for portrait images. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void Show ()
 Shows the controls by setting them active. More...
 
void Hide ()
 Hides the controls by setting them inactive. More...
 

Public Attributes

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

Properties

override AbstractUISubtitleControls NPCSubtitle [get]
 
override AbstractUISubtitleControls PCSubtitle [get]
 
override AbstractUIResponseMenuControls ResponseMenu [get]
 
- Properties inherited from PixelCrushers.DialogueSystem.AbstractDialogueUIControls
abstract AbstractUISubtitleControls NPCSubtitle [get]
 Gets the NPC subtitle controls. More...
 
abstract AbstractUISubtitleControls PCSubtitle [get]
 Gets the PC subtitle controls. More...
 
abstract AbstractUIResponseMenuControls ResponseMenu [get]
 Gets the response menu. More...
 

Detailed Description

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

Member Function Documentation

◆ SetActive()

override void PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.SetActive ( bool  value)
virtual

Sets the conversation controls active/inactive.

Parameters
valuetrue for active, false for inactive.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUIControls.

◆ SetPortraitCollection()

void PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.SetPortraitCollection ( tk2dSpriteCollectionData  portraitCollection)

Sets the sprite collection to use for portrait images.

Parameters
portraitCollectionPortrait collection.

◆ ShowPanel()

override void PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.ShowPanel ( )
virtual

Shows the main conversation panel, if assigned.

Implements PixelCrushers.DialogueSystem.AbstractDialogueUIControls.

Member Data Documentation

◆ npcSubtitle

TK2DSubtitleControls PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.npcSubtitle

The NPC subtitle controls.

◆ panel

tk2dUILayout PixelCrushers.DialogueSystem.TK2D.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.TK2D.TK2DDialogueControls.pcSubtitle

The PC subtitle controls.

◆ responseMenu

TK2DResponseMenuControls PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.responseMenu

The response menu controls.

Property Documentation

◆ NPCSubtitle

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.NPCSubtitle
get

◆ PCSubtitle

override AbstractUISubtitleControls PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.PCSubtitle
get

◆ ResponseMenu

override AbstractUIResponseMenuControls PixelCrushers.DialogueSystem.TK2D.TK2DDialogueControls.ResponseMenu
get

The documentation for this class was generated from the following file: