PixelCrushers.DialogueSystem.TK2D.TK2DFader Class Reference

Provides a fade in/out effect for TK2D sprites and text meshes. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DFader:

Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DFader:

Public Member Functions
void	SetDurations (float fadeInDuration, float showDuration, float fadeOutDuration)
IEnumerator	Play ()

Public Attributes
float	fadeInDuration = 0.2f
	The duration in seconds to fade in. More...
float	showDuration = 1f
	The duration in seconds to show the sprite/text mesh before fading out. More...
float	fadeOutDuration = 0.2f
	The duration in seconds to fade out. More...
bool	fadeOnEnable = true

Detailed Description

Provides a fade in/out effect for TK2D sprites and text meshes.

Makes the TK2D element fade in/out when the game object is activated.

Member Function Documentation

Play()

IEnumerator PixelCrushers.DialogueSystem.TK2D.TK2DFader.Play

(

)

SetDurations()

void PixelCrushers.DialogueSystem.TK2D.TK2DFader.SetDurations	(	float	fadeInDuration,
		float	showDuration,
		float	fadeOutDuration
	)

Member Data Documentation

fadeInDuration

float PixelCrushers.DialogueSystem.TK2D.TK2DFader.fadeInDuration = 0.2f

The duration in seconds to fade in.

fadeOnEnable

bool PixelCrushers.DialogueSystem.TK2D.TK2DFader.fadeOnEnable = true

fadeOutDuration

float PixelCrushers.DialogueSystem.TK2D.TK2DFader.fadeOutDuration = 0.2f

The duration in seconds to fade out.

If 0, there is no fade out and the sprite/text mesh stays visible.

showDuration

float PixelCrushers.DialogueSystem.TK2D.TK2DFader.showDuration = 1f

The duration in seconds to show the sprite/text mesh before fading out.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/TK2D Integration/Assets/Dialogue System/Third Party Support/TK2D/TK2D Dialogue UI/TK2DFader.cs