This feedback will let you reveal words, lines, or characters in a target TMP, one at a time More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_TMPTextReveal:

Public Types
enum	RevealModes { Character , Lines , Words }
	the possible ways to reveal the text More...

enum	DurationModes { Interval , TotalDuration }
	whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take More...

Public Attributes
TMP_Text	TargetTMPText
	the target TMP_Text component we want to change the text on More...

bool	ReplaceText = false
	whether or not to replace the current TMP target's text on play More...

string	NewText = "Hello World"
	the new text to replace the old one with More...

RevealModes	RevealMode = RevealModes.Character
	the selected way to reveal the text (character by character, word by word, or line by line) More...

DurationModes	DurationMode = DurationModes.Interval
	whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take More...

float	IntervalBetweenReveals = 0.05f
	the interval (in seconds) between two reveals More...

float	RevealDuration = 1f
	the total duration of the text reveal, in seconds More...

Public Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
bool	Active = true
	whether or not this feedback is active More...

int	UniqueID

string	Label = "MMFeedback"
	the name of this feedback to display in the inspector More...

int	Channel = 0
	the ID of the channel on which this feedback will communicate More...

float	Chance = 100f
	the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...

Color	DisplayColor = Color.black
	use this color to customize the background color of the feedback in the MMF_Player's list More...

MMFeedbackTiming	Timing
	a number of timing-related values (delay, repeat, etc) More...

MMF_Player	Owner
	the Owner of the feedback, as defined when calling the Initialization method More...

bool	DebugActive = false
	whether or not this feedback is in debug mode More...

Static Public Attributes
static bool	FeedbackTypeAuthorized = true
	a static bool used to disable all feedbacks of this type at once More...

Protected Member Functions
override void	CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	On play we change the text of our target TMPText More...

virtual IEnumerator	RevealCharacters ()
	Reveals characters one at a time More...

virtual IEnumerator	RevealLines ()
	Reveals lines one at a time More...

virtual IEnumerator	RevealWords ()
	Reveals words one at a time More...

override void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
	Stops the animation if needed More...

int	RichTextLength (string richText)
	Returns the length of a rich text, excluding its tags More...

Protected Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	An internal coroutine delaying the initial play of the feedback More...

virtual void	RegularPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Triggers delaying coroutines if needed More...

virtual IEnumerator	InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play without end More...

virtual IEnumerator	RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play More...

virtual IEnumerator	SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to play this feedback on a sequence More...

virtual float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual float	ApplyDirection (float normalizedTime)
	Returns a new value of the normalized time based on the current play direction of this feedback More...

virtual void	CustomInitialization (MMF_Player owner)
	This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...

virtual void	CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets skipped to the end More...

virtual void	CustomReset ()
	This method describes what happens when the feedback gets reset More...

Protected Attributes
float	_delay

Coroutine	_coroutine

int	_richTextLength

Protected Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

bool	_requiresSetup = false

string	_requiredTarget = ""

int	_sequenceTrackID = 0

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

Properties
override float	FeedbackDuration `[getset]`
	the duration of this feedback More...

Properties inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	Pause `[get]`
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	ScriptDrivenPause `[getset]`
	if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...

virtual float	ScriptDrivenPauseAutoResume `[getset]`
	if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More...

virtual bool	LooperStart `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	HasChannel `[get]`
	if this is true, the Channel property will be displayed, otherwise it'll be hidden More...

virtual bool	HasCustomInspectors `[get]`

virtual bool	InCooldown `[get]`
	returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...

virtual bool	IsPlaying `[getset]`
	if this is true, this feedback is currently playing More...

virtual float	FeedbackTime `[get]`
	the time (or unscaled time) based on the selected Timing settings More...

virtual float	FeedbackDeltaTime `[get]`
	the delta time (or unscaled delta time) based on the selected Timing settings More...

virtual float	TotalDuration `[get]`
	The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More...

bool	RequiresSetup `[get]`
	A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played. More...

string	RequiredTarget `[get]`

virtual bool	DrawGroupInspectors `[get]`

virtual string	RequiresSetupText `[get]`

virtual string	RequiredTargetText `[get]`

virtual float?	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[getset]`

virtual bool	FeedbackPlaying `[get]`
	whether or not this feedback is playing right now More...

virtual float?	FinalNormalizedTime `[get]`
	Returns the t value at which to evaluate a curve at the end of this feedback's play time More...

virtual bool	NormalPlayDirection `[get]`
	Returns true if this feedback should play normally, or false if it should play in rewind More...

virtual bool	ShouldPlayInThisSequenceDirection `[get]`
	Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...

Additional Inherited Members
Public Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual void	CacheRequiresSetup ()

virtual bool	EvaluateRequiresSetup ()
	Override this method to determine if a feedback requires setup More...

virtual void	Initialization (MMF_Player owner)
	Initializes the feedback and its timing related variables More...

virtual void	Play (Vector3 position, float feedbacksIntensity=1.0f)
	Plays the feedback More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime More...

virtual void	Stop (Vector3 position, float feedbacksIntensity=1.0f)
	Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...

virtual void	SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	SetDelayBetweenRepeats (float delay)
	Use this method to specify a new delay between repeats at runtime More...

virtual void	SetInitialDelay (float delay)
	Use this method to specify a new initial delay at runtime More...

virtual void	InitializeCustomAttributes ()
	Use this method to initialize any custom attributes you may have More...

virtual void	OnValidate ()
	Triggered when a change happens in the inspector More...

virtual void	OnDestroy ()
	Triggered when that feedback gets destroyed More...

Detailed Description

This feedback will let you reveal words, lines, or characters in a target TMP, one at a time

Member Enumeration Documentation

◆ DurationModes

enum MoreMountains.Feedbacks.MMF_TMPTextReveal.DurationModes

whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take

Enumerator
Interval
TotalDuration

◆ RevealModes

enum MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealModes

the possible ways to reveal the text

Enumerator
Character
Lines
Words

Member Function Documentation

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_TMPTextReveal.CustomPlayFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1.0f`
	)

protectedvirtual

On play we change the text of our target TMPText

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_TMPTextReveal.CustomStopFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1`
	)

protectedvirtual

Stops the animation if needed

Parameters

position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ RevealCharacters()

virtual IEnumerator MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealCharacters ( )

protectedvirtual

Reveals characters one at a time

Returns

◆ RevealLines()

virtual IEnumerator MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealLines ( )

protectedvirtual

Reveals lines one at a time

Returns

◆ RevealWords()

virtual IEnumerator MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealWords ( )

protectedvirtual

Reveals words one at a time

Returns

◆ RichTextLength()

int MoreMountains.Feedbacks.MMF_TMPTextReveal.RichTextLength ( string richText )

protected

Returns the length of a rich text, excluding its tags

Parameters

richText

Returns

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_TMPTextReveal._coroutine

protected

◆ _delay

float MoreMountains.Feedbacks.MMF_TMPTextReveal._delay

protected

◆ _richTextLength

int MoreMountains.Feedbacks.MMF_TMPTextReveal._richTextLength

protected

◆ DurationMode

DurationModes MoreMountains.Feedbacks.MMF_TMPTextReveal.DurationMode = DurationModes.Interval

whether to define duration by the time interval between two unit reveals, or by the total duration the reveal should take

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_TMPTextReveal.FeedbackTypeAuthorized = true

static

a static bool used to disable all feedbacks of this type at once

◆ IntervalBetweenReveals

float MoreMountains.Feedbacks.MMF_TMPTextReveal.IntervalBetweenReveals = 0.05f

the interval (in seconds) between two reveals

◆ NewText

string MoreMountains.Feedbacks.MMF_TMPTextReveal.NewText = "Hello World"

the new text to replace the old one with

◆ ReplaceText

bool MoreMountains.Feedbacks.MMF_TMPTextReveal.ReplaceText = false

whether or not to replace the current TMP target's text on play

◆ RevealDuration

float MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealDuration = 1f

the total duration of the text reveal, in seconds

◆ RevealMode

RevealModes MoreMountains.Feedbacks.MMF_TMPTextReveal.RevealMode = RevealModes.Character

the selected way to reveal the text (character by character, word by word, or line by line)

◆ TargetTMPText

TMP_Text MoreMountains.Feedbacks.MMF_TMPTextReveal.TargetTMPText

the target TMP_Text component we want to change the text on

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_TMPTextReveal.FeedbackDuration

getset

the duration of this feedback

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacksForThirdParty/TextMeshPro/Feedbacks/MMF_TMPTextReveal.cs

Public Types

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DurationModes

◆ RevealModes

Member Function Documentation

◆ CustomPlayFeedback()

◆ CustomStopFeedback()

◆ RevealCharacters()

◆ RevealLines()

◆ RevealWords()

◆ RichTextLength()

Member Data Documentation

◆ _coroutine

◆ _delay

◆ _richTextLength

◆ DurationMode

◆ FeedbackTypeAuthorized

◆ IntervalBetweenReveals

◆ NewText

◆ ReplaceText

◆ RevealDuration

◆ RevealMode

◆ TargetTMPText

Property Documentation

◆ FeedbackDuration