Table of Contents

Class TMPEffectComponent

Namespace
TMPEffects.Components
Assembly
TMPEffects.dll

Base class for TMPAnimator and TMPWriter.

public abstract class TMPEffectComponent : MonoBehaviour
Inheritance
Object
Component
Behaviour
MonoBehaviour
TMPEffectComponent
Derived
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.destroyCancellationToken
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.ToString()
Object.name
Object.hideFlags

Properties

Mediator

protected TMPMediator Mediator { get; }

Property Value

TMPMediator

TextComponent

The associated TMPro.TMP_Text component.

public TMP_Text TextComponent { get; }

Property Value

TMP_Text

Methods

FreeMediator()

protected void FreeMediator()

Hide(int, int, bool)

Hide a subset of the text's characters.

public void Hide(int start, int length, bool skipHideProcess = false)

Parameters

start int

First character index to hide.

length int

Amount of characters to hide.

skipHideProcess bool

Whether to skip the hide process.

Exceptions

InvalidOperationException

HideAll(bool)

Hide all of the text's character.

public void HideAll(bool skipHideProcess = false)

Parameters

skipHideProcess bool

Exceptions

InvalidOperationException

SetText(string)

Set the text of the associated TMPro.TMP_Text component.

public void SetText(string text)

Parameters

text string

The new text.

Show(int, int, bool)

Show a subset of the text's characters.

public void Show(int start, int length, bool skipShowProcess = false)

Parameters

start int

First character index to show.

length int

Amount of characters to show.

skipShowProcess bool

Whether to skip the show process.

Exceptions

InvalidOperationException

ShowAll(bool)

Show all of the text's character.

public void ShowAll(bool skipShowProcess = false)

Parameters

skipShowProcess bool

Whether to skip the show process.

Exceptions

InvalidOperationException

UpdateMediator()

protected void UpdateMediator()