Skip to main content

Class TMPTextSwitcherClip

A Timeline clip that defines a desired visual state for a TMPro.TextMeshProUGUI component.

Each clip contains a TMPTextSwitcherBehaviour template with the target settings for text, font size, and color. This template is not used directly during playback; it is cloned and injected into the playable graph as runtime data. The runtime data is then evaluated and blended by the TMPTextSwitcherMixerBehaviour to apply the visual state.

[Serializable]
public class TMPTextSwitcherClip : PlayableAsset, ITimelineClipAsset

Inheritance​

Implements​

ITimelineClipAsset

Properties​

clipCaps​

Specifies that this clip supports Timeline blending, so its behaviour can contribute to the mixer.

public ClipCaps clipCaps { get; }

Property Value​

ClipCaps

Methods​

CreatePlayable(PlayableGraph, GameObject)​

Creates a playable instance based on the behaviour template, which is then injected into the playable graph for evaluation. The instance is used by the TMPTextSwitcherMixerBehaviour to apply blending and visual state updates during playback.

public override Playable CreatePlayable(PlayableGraph graph, GameObject owner)

Parameters​

NameTypeDescription
graphPlayableGraphThe Playable Director's graph to which the TMPTextSwitcherBehaviour will be added.
ownerGameObjectThe GameObject that owns the Playable Director.

Returns​

Playable — A playable instance wrapped around the behaviour template, ready for evaluation by the mixer.