MoreMountains.TopDownEngine.DialogueBox Class Reference

Dialogue box class. Don't add this directly to your game, look at DialogueZone instead. More...

Inheritance diagram for MoreMountains.TopDownEngine.DialogueBox:

Public Member Functions
virtual void	ChangeText (string newText)
	Changes the text. More...
virtual void	ButtonActive (bool state)
	Activates the ButtonA prompt More...
virtual void	ChangeColor (Color backgroundColor, Color textColor)
	Changes the color of the dialogue box to the ones in parameters More...
virtual void	FadeIn (float duration)
	Fades the dialogue box in. More...
virtual void	FadeOut (float duration)
	Fades the dialogue box out. More...

Public Attributes
CanvasGroup	TextPanelCanvasGroup
	the text panel background More...
Text	DialogueText
	the text to display More...
CanvasGroup	Prompt
	the Button A prompt More...
List< Image >	ColorImages
	the list of images to colorize More...

Protected Attributes
Color	_backgroundColor
Color	_textColor

Detailed Description

Dialogue box class. Don't add this directly to your game, look at DialogueZone instead.

Member Function Documentation

ButtonActive()

virtual void MoreMountains.TopDownEngine.DialogueBox.ButtonActive ( bool  state )

virtual

Activates the ButtonA prompt

Parameters

state

If set to true state.

ChangeColor()

virtual void MoreMountains.TopDownEngine.DialogueBox.ChangeColor ( Color  backgroundColor, Color  textColor  )

virtual

Changes the color of the dialogue box to the ones in parameters

Parameters

backgroundColor	Background color.
textColor	Text color.

ChangeText()

virtual void MoreMountains.TopDownEngine.DialogueBox.ChangeText ( string  newText )

virtual

Changes the text.

Parameters

newText

New text.

FadeIn()

virtual void MoreMountains.TopDownEngine.DialogueBox.FadeIn ( float  duration )

virtual

Fades the dialogue box in.

Parameters

duration

Duration.

FadeOut()

virtual void MoreMountains.TopDownEngine.DialogueBox.FadeOut ( float  duration )

virtual

Fades the dialogue box out.

Parameters

duration

Duration.

Member Data Documentation

_backgroundColor

Color MoreMountains.TopDownEngine.DialogueBox._backgroundColor

protected

_textColor

Color MoreMountains.TopDownEngine.DialogueBox._textColor

protected

ColorImages

List<Image> MoreMountains.TopDownEngine.DialogueBox.ColorImages

the list of images to colorize

DialogueText

Text MoreMountains.TopDownEngine.DialogueBox.DialogueText

the text to display

Prompt

CanvasGroup MoreMountains.TopDownEngine.DialogueBox.Prompt

the Button A prompt

TextPanelCanvasGroup

CanvasGroup MoreMountains.TopDownEngine.DialogueBox.TextPanelCanvasGroup

the text panel background

---

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

• F:/Github/Store/TopDownEngine/Assets/TopDownEngine/Common/Scripts/GUI/DialogueBox.cs