Class TMPEffectComponent

Namespace

TMPEffects.Components

Base class for TMPAnimator and TMPWriter.

public abstract class TMPEffectComponent : MonoBehaviour

Inheritance

object

TMPEffectComponent

Derived

TMPAnimator

TMPWriter

Properties

CharData

The associated CharData.

public ReadOnlyCollection<CharData> CharData { get; }

Property Value

ReadOnlyCollection<CharData>

Mediator

protected TMPMediator Mediator { get; }

Property Value

TMPMediator

TextComponent

The associated 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

OnSubscribeToMediator()

protected void OnSubscribeToMediator()

OnUnsubscribeFromMediator()

protected void OnUnsubscribeFromMediator()

SetText(string)

Set the text of the associated 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()

Events

OnTextChanged

Raised when the associated TMP_Text component's text changes.
The bool parameter indicates whether the actual text content changed.

public event TMPEffectComponent.OnTextChangedEventHandler OnTextChanged

Event Type

TMPEffectComponent.OnTextChangedEventHandler