PixelCrushers.DialogueSystem.AbstractUISubtitleControls Class Reference

Abstract subtitle controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUISubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUISubtitleControls:

Public Member Functions
void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle controls' contents.
void	ClearSubtitle ()
	Clears the subtitle controls' contents.
virtual void	ShowContinueButton ()
	Shows the continue button.
virtual void	HideContinueButton ()
	Hides the continue button.
virtual void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle controls.
virtual void	SetActorPortraitSprite (string actorName, Sprite sprite)
	Sets the portrait sprite to use in the subtitle if the named actor is the speaker.
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.

Protected Attributes
Subtitle	currentSubtitle = null

Properties
bool	hasText [get]
	Gets a value indicating whether text has been assigned to the subtitle controls.

Detailed Description

Abstract subtitle controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

ClearSubtitle()

void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.ClearSubtitle ( )

abstract

Clears the subtitle controls' contents.

HideContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.HideContinueButton ( )

inlinevirtual

Hides the continue button.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.TK2DSupport.TK2DSubtitleControls, PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls, PixelCrushers.DialogueSystem.StandardUISubtitleControls, and PixelCrushers.DialogueSystem.UnityUISubtitleControls.

SetActorPortraitSprite()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.SetActorPortraitSprite ( string  actorName, Sprite  sprite  )

inlinevirtual

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

Parameters

actorName	Actor name in database.
sprite	Portrait sprite.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls, PixelCrushers.DialogueSystem.StandardUISubtitleControls, and PixelCrushers.DialogueSystem.UnityUISubtitleControls.

SetActorPortraitTexture()

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

inlinevirtual

SetSubtitle()

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

abstract

Sets the subtitle controls' contents.

Parameters

subtitle

Subtitle.

ShowContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractUISubtitleControls.ShowContinueButton ( )

inlinevirtual

Shows the continue button.

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProSubtitleControls, PixelCrushers.DialogueSystem.UnityGUI.UnitySubtitleControls, PixelCrushers.DialogueSystem.StandardUISubtitleControls, and PixelCrushers.DialogueSystem.UnityUISubtitleControls.

ShowSubtitle()

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

inlinevirtual

Shows the subtitle controls.

Parameters

subtitle

Subtitle.

Reimplemented in PixelCrushers.DialogueSystem.StandardUISubtitleControls.

Member Data Documentation

currentSubtitle

Subtitle PixelCrushers.DialogueSystem.AbstractUISubtitleControls.currentSubtitle = null

protected

Property Documentation

hasText

bool PixelCrushers.DialogueSystem.AbstractUISubtitleControls.hasText

getabstract

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:

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Abstract/Dialogue/AbstractUISubtitleControls.cs