PixelCrushers.DialogueSystem.UnityGUI.GUIEffect Class Reference

The base abstract class for GUI effect "decorators" that can be added to GUI controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIEffect:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIEffect:

Public Member Functions
abstract IEnumerator	Play ()
	Plays the effect. More...
virtual void	Stop ()
void	OnEnable ()
void	OnDisable ()

Public Attributes
GUIEffectTrigger	trigger = GUIEffectTrigger.OnEnable
	The trigger that makes the effect play. More...

Detailed Description

The base abstract class for GUI effect "decorators" that can be added to GUI controls.

These effects change the way GUI controls are displayed.

Member Function Documentation

OnDisable()

void PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.OnDisable

(

)

OnEnable()

void PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.OnEnable

(

)

Play()

abstract IEnumerator PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.Play ( )

pure virtual

Plays the effect.

Each effect overrides this abstract method.

Implemented in PixelCrushers.DialogueSystem.UnityGUI.FadeEffect, PixelCrushers.DialogueSystem.UnityGUI.SlideEffect, PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect, PixelCrushers.DialogueSystem.UnityGUI.TimerEffect, PixelCrushers.DialogueSystem.UnityGUI.AudioEffect, and PixelCrushers.DialogueSystem.UnityGUI.FlashEffect.

Stop()

virtual void PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.Stop ( )

virtual

Reimplemented in PixelCrushers.DialogueSystem.UnityGUI.TypewriterEffect.

Member Data Documentation

trigger

GUIEffectTrigger PixelCrushers.DialogueSystem.UnityGUI.GUIEffect.trigger = GUIEffectTrigger.OnEnable

The trigger that makes the effect play.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Source/Assets/Dialogue System/Scripts/Supplemental/Unity GUI/GUI Controls/Effects/GUIEffect.cs