Subtitle Unity UI controls for UnityUIDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityUISubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityUISubtitleControls:

[legend]

Public Member Functions
void	CheckSubtitlePortrait (CharacterType characterType)

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

void	ForceHide ()

void	ForceShow ()

void	ActivateUIElements ()

void	DeactivateUIElements ()

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

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

override void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle. More...

override void	ClearSubtitle ()
	Clears the subtitle. 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...

void	AutoFocus (bool allowStealFocus=true)
	Auto-focuses the continue button. 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
UnityEngine.UI.Graphic	panel
	The panel containing the response menu controls. More...

UnityEngine.UI.Text	line
	The label that will show the text of the subtitle. More...

UnityEngine.UI.Image	portraitImage
	The label that will show the portrait image. More...

UnityEngine.UI.Text	portraitName
	The label that will show the name of the speaker. More...

UnityEngine.UI.Button	continueButton
	The continue button. More...

bool	ignorePauseCodes = false

UIAnimationTransitions	animationTransitions = new UIAnimationTransitions()

UIVisibility	uiVisibility = UIVisibility.OnlyDuringContent

Properties
bool?	isVisible `[get]`

override bool	HasText `[get]`
	Indicates whether this subtitle is currently assigned text. 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 Unity UI controls for UnityUIDialogueUI.

Member Function Documentation

◆ ActivateUIElements()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.ActivateUIElements ( )

◆ AutoFocus()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.AutoFocus ( bool allowStealFocus = true )

Auto-focuses the continue button.

Useful for gamepads.

◆ CheckSubtitlePortrait()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.CheckSubtitlePortrait ( CharacterType characterType )

◆ ClearSubtitle()

override void PixelCrushers.DialogueSystem.UnityUISubtitleControls.ClearSubtitle ( )

virtual

Clears the subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ DeactivateUIElements()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.DeactivateUIElements ( )

◆ ForceHide()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.ForceHide ( )

◆ ForceShow()

void PixelCrushers.DialogueSystem.UnityUISubtitleControls.ForceShow ( )

◆ HideContinueButton()

override void PixelCrushers.DialogueSystem.UnityUISubtitleControls.HideContinueButton ( )

virtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ SetActive()

override void PixelCrushers.DialogueSystem.UnityUISubtitleControls.SetActive ( bool value )

virtual

Sets the controls active/inactive.

Parameters

value true for active, false for inactive.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetActorPortraitTexture()

override void PixelCrushers.DialogueSystem.UnityUISubtitleControls.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.UnityUISubtitleControls.SetSubtitle ( Subtitle subtitle )

virtual

Sets the subtitle.

Parameters

subtitle Subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

◆ ShowContinueButton()

override void PixelCrushers.DialogueSystem.UnityUISubtitleControls.ShowContinueButton ( )

virtual

Shows the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

Member Data Documentation

◆ animationTransitions

UIAnimationTransitions PixelCrushers.DialogueSystem.UnityUISubtitleControls.animationTransitions = new UIAnimationTransitions()

◆ continueButton

UnityEngine.UI.Button PixelCrushers.DialogueSystem.UnityUISubtitleControls.continueButton

The continue button.

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

◆ ignorePauseCodes

bool PixelCrushers.DialogueSystem.UnityUISubtitleControls.ignorePauseCodes = false

◆ line

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUISubtitleControls.line

The label that will show the text of the subtitle.

◆ panel

UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUISubtitleControls.panel

The panel containing the response menu controls.

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

◆ portraitImage

UnityEngine.UI.Image PixelCrushers.DialogueSystem.UnityUISubtitleControls.portraitImage

The label that will show the portrait image.

◆ portraitName

UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUISubtitleControls.portraitName

The label that will show the name of the speaker.

◆ uiVisibility

UIVisibility PixelCrushers.DialogueSystem.UnityUISubtitleControls.uiVisibility = UIVisibility.OnlyDuringContent

Property Documentation

◆ HasText

override bool PixelCrushers.DialogueSystem.UnityUISubtitleControls.HasText

get

Indicates whether this subtitle is currently assigned text.

true if it has text; otherwise, false.

◆ isVisible

bool? PixelCrushers.DialogueSystem.UnityUISubtitleControls.isVisible

get

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

D:/Documents/Unity Projects/Dialogue System/Dev/Release/Assets/Dialogue System/Scripts/Supplemental/UI/Dialogue UI/UnityUISubtitleControls.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ActivateUIElements()

◆ AutoFocus()

◆ CheckSubtitlePortrait()

◆ ClearSubtitle()

◆ DeactivateUIElements()

◆ ForceHide()

◆ ForceShow()

◆ HideContinueButton()

◆ SetActive()

◆ SetActorPortraitTexture()

◆ SetSubtitle()

◆ ShowContinueButton()

Member Data Documentation

◆ animationTransitions

◆ continueButton

◆ ignorePauseCodes

◆ line

◆ panel

◆ portraitImage

◆ portraitName

◆ uiVisibility

Property Documentation

◆ HasText

◆ isVisible