MoreMountains.CorgiEngine.DialogueBox Class Reference

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

Inheritance diagram for MoreMountains.CorgiEngine.DialogueBox:

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

Public Attributes
Image	TextPanel
	the text panel background
Image	TextPanelArrowDown
	the arrow pointing down on the dialogue box
Text	DialogueText
	the text to display
GameObject	ButtonA
	the Button A prompt

Protected Attributes
Color	_backgroundColor
Color	_textColor
SpriteRenderer	_buttonSpriteRenderer

Detailed Description

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

Member Function Documentation

ButtonActive()

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

virtual

Activates the ButtonA prompt.

Parameters

state

If set to true state.

ChangeColor()

virtual void MoreMountains.CorgiEngine.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.CorgiEngine.DialogueBox.ChangeText ( string newText )

virtual

Changes the text.

Parameters

newText

New text.

FadeIn()

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

virtual

Fades the dialogue box in.

Parameters

duration

Duration.

FadeOut()

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

virtual

Fades the dialogue box out.

Parameters

duration

Duration.

HideArrow()

virtual void MoreMountains.CorgiEngine.DialogueBox.HideArrow ( )

virtual

Hides the dialogue box arrow.

Member Data Documentation

_backgroundColor

Color MoreMountains.CorgiEngine.DialogueBox._backgroundColor

protected

_buttonSpriteRenderer

SpriteRenderer MoreMountains.CorgiEngine.DialogueBox._buttonSpriteRenderer

protected

_textColor

Color MoreMountains.CorgiEngine.DialogueBox._textColor

protected

ButtonA

GameObject MoreMountains.CorgiEngine.DialogueBox.ButtonA

the Button A prompt

DialogueText

Text MoreMountains.CorgiEngine.DialogueBox.DialogueText

the text to display

TextPanel

Image MoreMountains.CorgiEngine.DialogueBox.TextPanel

the text panel background

TextPanelArrowDown

Image MoreMountains.CorgiEngine.DialogueBox.TextPanelArrowDown

the arrow pointing down on the dialogue box

---

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

• Assets/CorgiEngine/Common/Scripts/GUI/Dialogue/DialogueBox.cs