PixelCrushers.DialogueSystem.UnityGUI.FadeEffect Class Reference

Applies a fade effect to a GUI control. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.FadeEffect:
Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.FadeEffect:

Public Member Functions

void SetFadeDurations (float fadeInDuration, float duration, float fadeOutDuration)
 
override IEnumerator Play ()
 Plays the fade effect. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
virtual void Stop ()
 
void OnEnable ()
 
void OnDisable ()
 

Public Attributes

float fadeInDuration = 0.5f
 The duration to fade in. More...
 
float duration = 1f
 The duration to stay visible before fading out. More...
 
float fadeOutDuration = 0.5f
 The duration to fade out. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
GUIEffectTrigger trigger = GUIEffectTrigger.OnEnable
 The trigger that makes the effect play. More...
 

Detailed Description

Applies a fade effect to a GUI control.

This effect works by changing the alpha value of GUI style.

Member Function Documentation

◆ Play()

override IEnumerator PixelCrushers.DialogueSystem.UnityGUI.FadeEffect.Play ( )
virtual

Plays the fade effect.

Implements PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.

◆ SetFadeDurations()

void PixelCrushers.DialogueSystem.UnityGUI.FadeEffect.SetFadeDurations ( float  fadeInDuration,
float  duration,
float  fadeOutDuration 
)

Member Data Documentation

◆ duration

float PixelCrushers.DialogueSystem.UnityGUI.FadeEffect.duration = 1f

The duration to stay visible before fading out.

◆ fadeInDuration

float PixelCrushers.DialogueSystem.UnityGUI.FadeEffect.fadeInDuration = 0.5f

The duration to fade in.

◆ fadeOutDuration

float PixelCrushers.DialogueSystem.UnityGUI.FadeEffect.fadeOutDuration = 0.5f

The duration to fade out.

If zero, the control doesn't fade out.


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