PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls Class Reference

Subtitle NGUI controls for NGUIDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the subtitle controls active or inactive.
override void	HideContinueButton ()
	Hides the continue button.
override void	SetSubtitle (Subtitle subtitle)
	Sets the subtitle.
override void	ClearSubtitle ()
	Clears the subtitle.
override void	SetActorPortraitSprite (string actorName, Sprite portraitSprite)
	Sets the portrait texture 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	ShowContinueButton ()
	Shows the continue button.
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
global::UIPanel	panel
	The panel containing the response menu controls.
UILabel	line
	The label that will show the text of the subtitle.
UITexture	portraitImage
	The label that will show the portrait image.
UILabel	portraitName
	The label that will show the name of the speaker.
UIButton	continueButton
	The continue button.
Color	originalColor = Color.clear

Properties
override bool	hasText [get]
	Indicates whether this subtitle is currently assigned text.
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 NGUI controls for NGUIDialogueUI.

Member Function Documentation

ClearSubtitle()

override void PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.ClearSubtitle ( )

inline

Clears the subtitle.

HideContinueButton()

override void PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.HideContinueButton ( )

inlinevirtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

SetActive()

override void PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.SetActive ( bool  value )

inline

Sets the subtitle controls active or inactive.

Parameters

value

true for active; false for inactive.

SetActorPortraitSprite()

override void PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.SetActorPortraitSprite ( string  actorName, Sprite  portraitSprite  )

inlinevirtual

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.NGUISupport.NGUISubtitleControls.SetSubtitle ( Subtitle  subtitle )

inline

Sets the subtitle.

Parameters

subtitle

Subtitle.

Member Data Documentation

continueButton

UIButton PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.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.

line

UILabel PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.line

The label that will show the text of the subtitle.

originalColor

Color PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.originalColor = Color.clear

panel

global.UIPanel PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.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

UITexture PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.portraitImage

The label that will show the portrait image.

portraitName

UILabel PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.portraitName

The label that will show the name of the speaker.

Property Documentation

hasText

override bool PixelCrushers.DialogueSystem.NGUISupport.NGUISubtitleControls.hasText

get

Indicates whether this subtitle is currently assigned text.

true if it has text; otherwise, false.

---

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

• C:/Dev/Dialogue System/Dev/Integration2/NGUI Integration/Assets/Pixel Crushers/Dialogue System/Third Party Support/NGUI Support/Scripts/NGUI Dialogue UI/NGUI Dialogue Controls/NGUISubtitleControls.cs