PixelCrushers.DialogueSystem.UnityGUI.SlideEffect Class Reference

Applies a slide effect to the GUI control, making it slide onscreen from a direction. More...

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

Public Types

enum  SlideDirection { SlideDirection.FromBottom, SlideDirection.FromTop, SlideDirection.FromLeft, SlideDirection.FromRight }
 Directions that the effect can slide from. More...
 

Public Member Functions

override IEnumerator Play ()
 Play the slide effect. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
virtual void Stop ()
 
void OnEnable ()
 
void OnDisable ()
 

Public Attributes

SlideDirection direction
 The direction to slide from. More...
 
float duration = 0.3f
 The duration over which to animate the slide. 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 slide effect to the GUI control, making it slide onscreen from a direction.

Member Enumeration Documentation

◆ SlideDirection

Directions that the effect can slide from.

Enumerator
FromBottom 
FromTop 
FromLeft 
FromRight 

Member Function Documentation

◆ Play()

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

Play the slide effect.

Implements PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.

Member Data Documentation

◆ direction

SlideDirection PixelCrushers.DialogueSystem.UnityGUI.SlideEffect.direction

The direction to slide from.

◆ duration

float PixelCrushers.DialogueSystem.UnityGUI.SlideEffect.duration = 0.3f

The duration over which to animate the slide.


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