Applies a timer effect to a GUIProgressBar that counts down from 1 to 0. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.TimerEffect:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.TimerEffect:

Public Member Functions
override IEnumerator	Play ()
	Run the timer. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
virtual void	Stop ()

void	OnEnable ()

void	OnDisable ()

Public Attributes
float	duration = 5f
	The timer duration. More...

Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIEffect
GUIEffectTrigger	trigger = GUIEffectTrigger.OnEnable
	The trigger that makes the effect play. More...

Events
Action	TimeoutHandler = null
	Occurs when the timer is done (i.e., at the end of duration). More...

Detailed Description

Applies a timer effect to a GUIProgressBar that counts down from 1 to 0.

When time is up, it calls an event handler.

Member Function Documentation

override IEnumerator PixelCrushers.DialogueSystem.UnityGUI.TimerEffect.Play ( )

virtual

Run the timer.

float PixelCrushers.DialogueSystem.UnityGUI.TimerEffect.duration = 5f

The timer duration.

Action PixelCrushers.DialogueSystem.UnityGUI.TimerEffect.TimeoutHandler = null

Occurs when the timer is done (i.e., at the end of duration).

If the coroutine is stopped or the control is deactivated, this will never get called.

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/TimerEffect.cs