PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls Class Reference

Subtitle GUI controls for UnityDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the controls active/inactive.
override void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents.
override void	ClearSubtitle ()
	Clears the subtitle controls' contents.
override void	ShowContinueButton ()
	Shows the continue button.
override void	HideContinueButton ()
	Hides the continue button.
override void	SetActorPortraitSprite (string actorName, Sprite portraitSprite)
	Sets the portrait sprite to use in the subtitle if the named actor is the speaker.
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls
void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents.
void	ClearSubtitle ()
	Clears the subtitle controls' contents.
virtual void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle controls.
virtual void	SetActorPortraitTexture (string actorName, Texture2D texture)
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	SetActive (bool value)
	Sets the controls active/inactive.
void	Show ()
	Shows the controls by setting them active.
void	Hide ()
	Hides the controls by setting them inactive.

Public Attributes
GUIControl	panel
	The alert panel.
GUILabel	line
	The label that will show the text of the subtitle.
GUILabel	portraitImage
	The label that will show the portrait image.
GUILabel	portraitName
	The label that will show the name of the speaker.
GUIButton	continueButton
	The continue button.

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

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 ( )

inline

Clears the subtitle controls' contents.

HideContinueButton()

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

inlinevirtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

SetActive()

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

inline

Sets the controls active/inactive.

Parameters

value

If set to true value.

SetActorPortraitSprite()

override void PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls.SetActorPortraitSprite ( string  actorName, Sprite  portraitSprite  )

inlinevirtual

Sets the portrait sprite 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 sprite.

Parameters

actorName	Actor name in database.
portraitSprite	Portrait sprite.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

SetSubtitle()

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

inline

Sets the subtitle controls' contents.

Parameters

subtitle

Subtitle.

ShowContinueButton()

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

inlinevirtual

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:

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Legacy/Dialogue/Controls/UnitySubtitleControls.cs