using System.Collections;
using System.Collections.Generic;
using UnityEngine;
#if MM_TEXTMESHPRO
using TMPro;
#endif
namespace MoreMountains.Feedbacks
{
///
/// This feedback will let you reveal words, lines, or characters in a target TMP, one at a time
///
[AddComponentMenu("")]
[FeedbackHelp("This feedback will let you reveal words, lines, or characters in a target TMP, one at a time")]
[FeedbackPath("TextMesh Pro/TMP Text Reveal")]
public class MMFeedbackTMPTextReveal : MMFeedback
{
/// a static bool used to disable all feedbacks of this type at once
public static bool FeedbackTypeAuthorized = true;
#if UNITY_EDITOR
public override Color FeedbackColor
{
get { return MMFeedbacksInspectorColors.TMPColor; }
}
#endif
#if MM_TEXTMESHPRO
/// the duration of this feedback
public override float FeedbackDuration
{
get
{
if (DurationMode == DurationModes.TotalDuration)
{
return RevealDuration;
}
else
{
if ((TargetTMPText == null) || (TargetTMPText.textInfo == null))
{
return 0f;
}
switch (RevealMode)
{
case RevealModes.Character:
return RichTextLength(TargetTMPText.text) * IntervalBetweenReveals;
case RevealModes.Lines:
return TargetTMPText.textInfo.lineCount * IntervalBetweenReveals;
case RevealModes.Words:
return TargetTMPText.textInfo.wordCount * IntervalBetweenReveals;
}
return 0f;
}
}
set
{
if (DurationMode == DurationModes.TotalDuration)
{
RevealDuration = value;
}
else
{
if (TargetTMPText != null)
{
switch (RevealMode)
{
case RevealModes.Character:
IntervalBetweenReveals = value / RichTextLength(TargetTMPText.text);
break;
case RevealModes.Lines:
IntervalBetweenReveals = value / TargetTMPText.textInfo.lineCount;
break;
case RevealModes.Words:
IntervalBetweenReveals = value / TargetTMPText.textInfo.wordCount;
break;
}
}
}
}
}
#endif
/// the possible ways to reveal the text
public enum RevealModes
{
Character,
Lines,
Words
}
/// whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take
public enum DurationModes
{
Interval,
TotalDuration
}
#if MM_TEXTMESHPRO
[Header("TextMesh Pro")]
/// the target TMP_Text component we want to change the text on
[Tooltip("the target TMP_Text component we want to change the text on")]
public TMP_Text TargetTMPText;
#endif
[Header("Change Text")]
/// whether or not to replace the current TMP target's text on play
[Tooltip("whether or not to replace the current TMP target's text on play")]
public bool ReplaceText = false;
/// the new text to replace the old one with
[Tooltip("the new text to replace the old one with")] [TextArea]
public string NewText = "Hello World";
[Header("Reveal")]
/// the selected way to reveal the text (character by character, word by word, or line by line)
[Tooltip("the selected way to reveal the text (character by character, word by word, or line by line)")]
public RevealModes RevealMode = RevealModes.Character;
/// whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take
[Tooltip(
"whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take")]
public DurationModes DurationMode = DurationModes.Interval;
/// the interval (in seconds) between two reveals
[Tooltip("the interval (in seconds) between two reveals")]
[MMFEnumCondition("DurationMode", (int)DurationModes.Interval)]
public float IntervalBetweenReveals = 0.05f;
/// the total duration of the text reveal, in seconds
[Tooltip("the total duration of the text reveal, in seconds")]
[MMFEnumCondition("DurationMode", (int)DurationModes.TotalDuration)]
public float RevealDuration = 1f;
protected float _delay;
protected Coroutine _coroutine;
protected int _richTextLength;
///
/// On play we change the text of our target TMPText
///
///
///
protected override void CustomPlayFeedback(Vector3 position, float feedbacksIntensity = 1.0f)
{
if (!Active || !FeedbackTypeAuthorized)
{
return;
}
#if MM_TEXTMESHPRO
if (TargetTMPText == null)
{
return;
}
if (ReplaceText)
{
TargetTMPText.text = NewText;
TargetTMPText.ForceMeshUpdate();
}
_richTextLength = RichTextLength(TargetTMPText.text);
switch (RevealMode)
{
case RevealModes.Character:
_delay =
(DurationMode == DurationModes.Interval) ? IntervalBetweenReveals : RevealDuration / _richTextLength;
TargetTMPText.maxVisibleCharacters = 0;
_coroutine = StartCoroutine(RevealCharacters());
break;
case RevealModes.Lines:
_delay =
(DurationMode == DurationModes.Interval) ? IntervalBetweenReveals : RevealDuration / TargetTMPText.textInfo.lineCount;
TargetTMPText.maxVisibleLines = 0;
_coroutine = StartCoroutine(RevealLines());
break;
case RevealModes.Words:
_delay =
(DurationMode == DurationModes.Interval) ? IntervalBetweenReveals : RevealDuration / TargetTMPText.textInfo.wordCount;
TargetTMPText.maxVisibleWords = 0;
_coroutine = StartCoroutine(RevealWords());
break;
}
#endif
}
///
/// Reveals characters one at a time
///
///
protected virtual IEnumerator RevealCharacters()
{
float startTime = (Timing.TimescaleMode == TimescaleModes.Scaled) ? Time.time : Time.unscaledTime;
int totalCharacters = _richTextLength;
int visibleCharacters = 0;
float lastCharAt = 0f;
IsPlaying = true;
while (visibleCharacters <= totalCharacters)
{
float deltaTime = (Timing.TimescaleMode == TimescaleModes.Scaled)
? Time.deltaTime
: Time.unscaledDeltaTime;
float time = (Timing.TimescaleMode == TimescaleModes.Scaled) ? Time.time : Time.unscaledTime;
if (time - lastCharAt < IntervalBetweenReveals)
{
yield return null;
}
#if MM_TEXTMESHPRO
TargetTMPText.maxVisibleCharacters = visibleCharacters;
#endif
visibleCharacters++;
lastCharAt = time;
// we adjust our delay
float delay = 0f;
if (DurationMode == DurationModes.Interval)
{
_delay = Mathf.Max(IntervalBetweenReveals, deltaTime);
delay = _delay - deltaTime;
}
else
{
int remainingCharacters = totalCharacters - visibleCharacters;
float elapsedTime = time - startTime;
if (remainingCharacters != 0)
{
_delay = (RevealDuration - elapsedTime) / remainingCharacters;
}
delay = _delay - deltaTime;
}
if (Timing.TimescaleMode == TimescaleModes.Scaled)
{
yield return MMFeedbacksCoroutine.WaitFor(delay);
}
else
{
yield return MMFeedbacksCoroutine.WaitForUnscaled(delay);
}
}
#if MM_TEXTMESHPRO
TargetTMPText.maxVisibleCharacters = _richTextLength;
#endif
IsPlaying = false;
}
///
/// Reveals lines one at a time
///
///
protected virtual IEnumerator RevealLines()
{
#if MM_TEXTMESHPRO
int totalLines = TargetTMPText.textInfo.lineCount;
int visibleLines = 0;
IsPlaying = true;
while (visibleLines <= totalLines)
{
TargetTMPText.maxVisibleLines = visibleLines;
visibleLines++;
if (Timing.TimescaleMode == TimescaleModes.Scaled)
{
yield return MMFeedbacksCoroutine.WaitFor(_delay);
}
else
{
yield return MMFeedbacksCoroutine.WaitForUnscaled(_delay);
}
}
IsPlaying = false;
#else
yield return null;
#endif
}
///
/// Reveals words one at a time
///
///
protected virtual IEnumerator RevealWords()
{
#if MM_TEXTMESHPRO
int totalWords = TargetTMPText.textInfo.wordCount;
int visibleWords = 0;
IsPlaying = true;
while (visibleWords <= totalWords)
{
TargetTMPText.maxVisibleWords = visibleWords;
visibleWords++;
if (Timing.TimescaleMode == TimescaleModes.Scaled)
{
yield return MMFeedbacksCoroutine.WaitFor(_delay);
}
else
{
yield return MMFeedbacksCoroutine.WaitForUnscaled(_delay);
}
}
IsPlaying = false;
#else
yield return null;
#endif
}
///
/// Stops the animation if needed
///
///
///
protected override void CustomStopFeedback(Vector3 position, float feedbacksIntensity = 1)
{
if (!Active || !FeedbackTypeAuthorized)
{
return;
}
base.CustomStopFeedback(position, feedbacksIntensity);
IsPlaying = false;
if (_coroutine != null)
{
StopCoroutine(_coroutine);
_coroutine = null;
}
}
///
/// Returns the length of a rich text, excluding its tags
///
///
///
protected int RichTextLength(string richText)
{
int richTextLength = 0;
bool insideTag = false;
richText = richText.Replace("
", "-");
foreach (char character in richText)
{
if (character == '<')
{
insideTag = true;
continue;
}
else if (character == '>')
{
insideTag = false;
}
else if (!insideTag)
{
richTextLength++;
}
}
return richTextLength;
}
}
}