PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls Class Reference

Subtitle UI controls for TK2DDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the controls active/inactive. More...
override void	HideContinueButton ()
	Hides the continue button. More...
override void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents. More...
override void	ClearSubtitle ()
	Clears the subtitle controls' contents. More...
void	SetPortraitCollection (tk2dSpriteCollectionData portraitCollection)
	Sets the portrait collection. More...
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls
virtual void	ShowContinueButton ()
	Shows the continue button. More...
virtual void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle controls. More...
virtual void	SetActorPortraitTexture (string actorName, Texture2D portraitTexture)
	Sets the portrait texture to use in the subtitle if the named actor is the speaker. 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...
tk2dBaseSprite	portraitImage
	The label that will show the portrait image of the speaker. More...
tk2dTextMesh	portraitName
	The label that will show the name of the speaker. More...
tk2dTextMesh	line
	The label that will show the text of the subtitle. More...
tk2dUIItem	continueButton
	The continue button. More...

Properties
override bool	HasText [get]
Properties inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls
abstract bool	HasText [get]
	Gets a value indicating whether text has been assigned to the subtitle controls. More...

Additional Inherited Members
Protected Attributes inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls
Subtitle	currentSubtitle = null

Detailed Description

Subtitle UI controls for TK2DDialogueUI.

This class is used for NPC subtitles, NPC reminder subtitles (shown during the response menu), and PC subtitles.

Member Function Documentation

ClearSubtitle()

override void PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.ClearSubtitle ( )

virtual

Clears the subtitle controls' contents.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

HideContinueButton()

override void PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.HideContinueButton ( )

virtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

SetActive()

override void PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.SetActive ( bool  value )

virtual

Sets the controls active/inactive.

Parameters

value

true for active, false for inactive.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

SetPortraitCollection()

void PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.SetPortraitCollection

(

tk2dSpriteCollectionData

portraitCollection

)

Sets the portrait collection.

Parameters

portraitCollection

Portrait collection.

SetSubtitle()

override void PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.SetSubtitle ( Subtitle  subtitle )

virtual

Sets the subtitle controls' contents.

Parameters

subtitle

Subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

Member Data Documentation

continueButton

tk2dUIItem PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.continueButton

The continue button.

This button is only required if DisplaySettings.waitForContinueButton is true – in which case this button should send "OnContinue" to the UI when clicked.

line

tk2dTextMesh PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.line

The label that will show the text of the subtitle.

panel

tk2dUILayout PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.panel

The alert panel.

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

portraitImage

tk2dBaseSprite PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.portraitImage

The label that will show the portrait image of the speaker.

portraitName

tk2dTextMesh PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.portraitName

The label that will show the name of the speaker.

Property Documentation

HasText

override bool PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.HasText

get

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/TK2D Integration/Assets/Dialogue System/Third Party Support/TK2D/TK2D Dialogue UI/TK2DSubtitleControls.cs