Abstract subtitle controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUISubtitleControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUISubtitleControls:

[legend]

Public Member Functions
abstract void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents. More...

abstract void	ClearSubtitle ()
	Clears the subtitle controls' contents. More...

virtual void	ShowContinueButton ()
	Shows the continue button. More...

virtual void	HideContinueButton ()
	Hides 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
abstract void	SetActive (bool value)
	Sets the controls active/inactive. More...

void	Show ()
	Shows the controls by setting them active. More...

void	Hide ()
	Hides the controls by setting them inactive. More...

Protected Attributes
Subtitle	currentSubtitle = null

Properties
abstract bool	HasText `[get]`
	Gets a value indicating whether text has been assigned to the subtitle controls. More...

Detailed Description

Abstract subtitle controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

◆ ClearSubtitle()

abstract void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.ClearSubtitle ( )

pure virtual

Clears the subtitle controls' contents.

Implemented in PixelCrushers.DialogueSystem.UnityUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls, PixelCrushers.DialogueSystem.NGUI.NGUISubtitleControls, PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls, and PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.

◆ HideContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.HideContinueButton ( )

virtual

Hides the continue button.

Reimplemented in PixelCrushers.DialogueSystem.UnityUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls, PixelCrushers.DialogueSystem.NGUI.NGUISubtitleControls, and PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls.

◆ SetActorPortraitTexture()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.SetActorPortraitTexture	(	string	actorName,
		Texture2D	portraitTexture
	)

virtual

Sets the portrait texture to use in the subtitle if the named actor is the speaker.

Parameters

actorName	Actor name in database.
portraitTexture	Portrait texture.

Reimplemented in PixelCrushers.DialogueSystem.UnityUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls, PixelCrushers.DialogueSystem.NGUI.NGUISubtitleControls, and PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.

◆ SetSubtitle()

abstract void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.SetSubtitle ( Subtitle subtitle )

pure virtual

Sets the subtitle controls' contents.

Parameters

subtitle Subtitle.

Implemented in PixelCrushers.DialogueSystem.UnityUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls, PixelCrushers.DialogueSystem.NGUI.NGUISubtitleControls, PixelCrushers.DialogueSystem.TK2D.TK2DSubtitleControls, and PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.

◆ ShowContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.ShowContinueButton ( )

virtual

Shows the continue button.

Reimplemented in PixelCrushers.DialogueSystem.UnityUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProSubtitleControls, and PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.

◆ ShowSubtitle()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.ShowSubtitle ( Subtitle subtitle )

virtual

Shows the subtitle controls.

Parameters

subtitle Subtitle.

Member Data Documentation

◆ currentSubtitle

Subtitle PixelCrushers.DialogueSystem.AbstractUISubtitleControls.currentSubtitle = null

protected

Property Documentation

◆ HasText

abstract bool PixelCrushers.DialogueSystem.AbstractUISubtitleControls.HasText

get

Gets a value indicating whether text has been assigned to the subtitle controls.

true if it has text; otherwise, false.

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

D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Abstract UI/Abstract Dialogue UI/AbstractUISubtitleControls.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ ClearSubtitle()

◆ HideContinueButton()

◆ SetActorPortraitTexture()

◆ SetSubtitle()

◆ ShowContinueButton()

◆ ShowSubtitle()

Member Data Documentation

◆ currentSubtitle

Property Documentation

◆ HasText