Subtitle GUI controls for UnityDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls:

[legend]

Public Member Functions
override void	SetActive (bool value)
	Sets the controls active/inactive. More...

override void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents. More...

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

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

override void	HideContinueButton ()
	Hides the continue button. More...

override 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.AbstractUISubtitleControls
virtual void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle controls. 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
GUIControl	panel
	The alert panel. More...

GUILabel	line
	The label that will show the text of the subtitle. More...

GUILabel	portraitImage
	The label that will show the portrait image. More...

GUILabel	portraitName
	The label that will show the name of the speaker. More...

GUIButton	continueButton
	The continue button. More...

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

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 GUI controls for UnityDialogueUI.

Member Function Documentation

◆ ClearSubtitle()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.ClearSubtitle ( )

virtual

Clears the subtitle controls' contents.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ HideContinueButton()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.HideContinueButton ( )

virtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ SetActive()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.SetActive ( bool value )

virtual

Sets the controls active/inactive.

Parameters

value If set to true value.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetActorPortraitTexture()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.SetActorPortraitTexture	(	string	actorName,
		Texture2D	portraitTexture
	)

virtual

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

This is used to immediately update the GUI control if the SetPortrait() sequencer command changes the portrait texture.

Parameters

actorName	Actor name in database.
portraitTexture	Portrait texture.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ SetSubtitle()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.SetSubtitle ( Subtitle subtitle )

virtual

Sets the subtitle controls' contents.

Parameters

subtitle Subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ ShowContinueButton()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.ShowContinueButton ( )

virtual

Shows the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

Member Data Documentation

◆ continueButton

GUIButton PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.continueButton

The continue button.

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

◆ line

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.line

The label that will show the text of the subtitle.

◆ panel

GUIControl PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.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

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.portraitImage

The label that will show the portrait image.

◆ portraitName

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.portraitName

The label that will show the name of the speaker.

Property Documentation

◆ HasText

override bool PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.HasText

get

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

true if this instance 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/Unity GUI/Unity Dialogue UI/Dialogue GUI Controls/UnitySubtitleControls.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearSubtitle()

◆ HideContinueButton()

◆ SetActive()

◆ SetActorPortraitTexture()

◆ SetSubtitle()

◆ ShowContinueButton()

Member Data Documentation

◆ continueButton

◆ line

◆ panel

◆ portraitImage

◆ portraitName

Property Documentation

◆ HasText