PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls Class Reference

Subtitle DaikonForge controls for DaikonForgeDialogueUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls:

Collaboration diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the subtitle controls active or inactive. 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...
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls
virtual void	ShowContinueButton ()
	Shows the continue button. More...
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
dfPanel	panel
	The panel containing the controls. More...
dfLabel	line
	The label that will show the text of the subtitle. More...
dfRichTextLabel	richTextLine
	The rich text label that will show the text of the subtitle. More...
dfTextureSprite	portraitImage
	The sprite that will show the portrait image. More...
dfLabel	portraitName
	The label that will show the name of the speaker. More...
dfButton	continueButton
	The continue button. More...

Properties
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 DaikonForge controls for DaikonForgeDialogueUI.

This class is used for NPC subtitles, NPC reminder subtitles (shown during the response menu), and PC subtitles.

Member Function Documentation

ClearSubtitle()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.ClearSubtitle ( )

virtual

Clears the subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

HideContinueButton()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.HideContinueButton ( )

virtual

Hides the continue button.

Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

SetActive()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.SetActive ( bool  value )

virtual

Sets the subtitle controls active or inactive.

Parameters

value

true for active; false for inactive.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

SetActorPortraitTexture()

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

virtual

Sets the subtitle.

Parameters

subtitle

Subtitle.

Implements PixelCrushers.DialogueSystem.AbstractUISubtitleControls.

Member Data Documentation

continueButton

dfButton PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.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

dfLabel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.line

The label that will show the text of the subtitle.

panel

dfPanel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.panel

The panel containing the controls.

A panel is optional, but you may want one so you can include additional controls.

portraitImage

dfTextureSprite PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.portraitImage

The sprite that will show the portrait image.

portraitName

dfLabel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.portraitName

The label that will show the name of the speaker.

richTextLine

dfRichTextLabel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.richTextLine

The rich text label that will show the text of the subtitle.

If assigned, it takes precedence over line.

Property Documentation

HasText

override bool PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeSubtitleControls.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:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/DFGUI Integration/Assets/Dialogue System/Third Party Support/Daikon Forge GUI/Daikon Forge Dialogue UI/Daikon Forge Dialogue Controls/DaikonForgeSubtitleControls.cs