RainbowTextColor Class Reference

Inheritance diagram for RainbowTextColor:

Public Member Functions
void	Play ()
void	Stop ()

Public Attributes
float	duration = 3f
float	cyclesPerSecond = 1f
float	saturation = 1f
float	value = 1f
float	alphaMultiplier = 1f
bool	playOnEnable = true
bool	restoreOriginalColor = true

Private Member Functions
void	Awake ()
void	OnEnable ()
void	OnDisable ()
IEnumerator	Run ()

Private Attributes
Text	_text
Coroutine	_routine
Color	_originalColor

Detailed Description

Definition at line 7 of file RainbowTextColor.cs.

Member Function Documentation

Awake()

void RainbowTextColor.Awake ( )

inlineprivate

Definition at line 45 of file RainbowTextColor.cs.

    {
        _text = GetComponent<Text>();
        _originalColor = _text.color;
    }

References _originalColor, and _text.

OnDisable()

void RainbowTextColor.OnDisable ( )

inlineprivate

Definition at line 59 of file RainbowTextColor.cs.

    {
        Stop();
        if (restoreOriginalColor && _text != null)
        {
            _text.color = _originalColor;
        }
    }

References _originalColor, _text, restoreOriginalColor, and Stop().

OnEnable()

void RainbowTextColor.OnEnable ( )

inlineprivate

Definition at line 51 of file RainbowTextColor.cs.

    {
        if (playOnEnable)
        {
            Play();
        }
    }

References Play(), and playOnEnable.

Play()

void RainbowTextColor.Play ( )

inline

Definition at line 68 of file RainbowTextColor.cs.

    {
        if (_text == null)
        {
            _text = GetComponent<Text>();
        }
        if (!(_text == null))
        {
            _originalColor = _text.color;
            if (_routine != null)
            {
                StopCoroutine(_routine);
            }
            _routine = StartCoroutine(Run());
        }
    }

References _originalColor, _routine, _text, and Run().

Referenced by OnEnable().

Run()

IEnumerator RainbowTextColor.Run ( )

inlineprivate

Definition at line 98 of file RainbowTextColor.cs.

    {
        if (duration <= 0f)
        {
            _routine = null;
            yield break;
        }
        float elapsed = 0f;
        while (elapsed < duration)
        {
            elapsed += Time.unscaledDeltaTime;
            Color color = Color.HSVToRGB(Mathf.Repeat(elapsed * cyclesPerSecond, 1f), saturation, value);
            color.a = _originalColor.a * alphaMultiplier;
            _text.color = color;
            yield return null;
        }
        if (restoreOriginalColor)
        {
            _text.color = _originalColor;
        }
        _routine = null;
    }

References _originalColor, _routine, alphaMultiplier, Color, cyclesPerSecond, duration, restoreOriginalColor, saturation, and value.

Referenced by Play().

Stop()

void RainbowTextColor.Stop ( )

inline

Definition at line 85 of file RainbowTextColor.cs.

    {
        if (_routine != null)
        {
            StopCoroutine(_routine);
            _routine = null;
        }
        if (restoreOriginalColor && _text != null)
        {
            _text.color = _originalColor;
        }
    }

References _originalColor, _routine, _text, and restoreOriginalColor.

Referenced by OnDisable().

Member Data Documentation

_originalColor

Color RainbowTextColor._originalColor

private

Definition at line 43 of file RainbowTextColor.cs.

Referenced by Awake(), OnDisable(), Play(), Run(), and Stop().

_routine

Coroutine RainbowTextColor._routine

private

Definition at line 41 of file RainbowTextColor.cs.

Referenced by Play(), Run(), and Stop().

_text

Text RainbowTextColor._text

private

Definition at line 39 of file RainbowTextColor.cs.

Referenced by Awake(), OnDisable(), Play(), and Stop().

alphaMultiplier

float RainbowTextColor.alphaMultiplier = 1f

Definition at line 30 of file RainbowTextColor.cs.

Referenced by Run().

cyclesPerSecond

float RainbowTextColor.cyclesPerSecond = 1f

Definition at line 17 of file RainbowTextColor.cs.

Referenced by Run().

duration

float RainbowTextColor.duration = 3f

Definition at line 12 of file RainbowTextColor.cs.

Referenced by Run().

playOnEnable

bool RainbowTextColor.playOnEnable = true

Definition at line 34 of file RainbowTextColor.cs.

Referenced by OnEnable().

restoreOriginalColor

bool RainbowTextColor.restoreOriginalColor = true

Definition at line 37 of file RainbowTextColor.cs.

Referenced by OnDisable(), Run(), and Stop().

saturation

float RainbowTextColor.saturation = 1f

Definition at line 22 of file RainbowTextColor.cs.

Referenced by Run().

value

float RainbowTextColor.value = 1f

Definition at line 26 of file RainbowTextColor.cs.

Referenced by Run().

---

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

• Elin/Plugins.UI/RainbowTextColor.cs