UxrTextContentTween Class

Tweening component to animate a UI text component programatically or using the inspector. Supports both Unity’s Text and TMPro. The text interpolation can be used to create a typewriter kind of effect. Programatically it also offers the possibility to interpolate parameters in a text string.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Core.Components.UxrComponent(UxrTween)
              UltimateXR.Core.Components.UxrComponent(Canvas, UxrTween)
                UltimateXR.Animation.UI.UxrTween
                  UltimateXR.Animation.UI.UxrTextContentTween
Namespace: UltimateXR.Animation.UI
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

[DisallowMultipleComponent]
public class UxrTextContentTween : UxrTween

The UxrTextContentTween type exposes the following members.

Constructors

	Name	Description
	UxrTextContentTween

Properties

	Name	Description
	EndText	Animation end text
	FormatString	Animation format string, when UsesFormatString is true.
	FormatStringArgs	Animation format string parameter list, when UsesFormatString is true.
	StartText	Animation start text
	TargetBehaviour	Gets the Behaviour the tween animates. (Overrides UxrTween.TargetBehaviour.)
	TargetText	Gets the Text component whose string will be interpolated.
	Text	Gets or sets the text value.
	UsesFormatString	Gets whether the interpolation uses format string parameters. false: Interpolation will be a plain typewriter effect from StartText to EndText true: Interpolation will use FormatString and FormatStringArgs. For more information on how these are used see UxrInterpolator.InterpolateText

Methods

	Name	Description
	Animate(GameObject, String, String, UxrInterpolationSettings, Action(UxrTween))	Creates and starts a tweening animation for a Unity UI Text component or TMPro text component.
	Animate(GameObject, UxrInterpolationSettings, Action(UxrTween), String, Object[])	Creates and starts a tweening animation for a Unity UI Text component or TMPro text component. See UxrInterpolator.InterpolateText for information on how formatString and formatStringArgs work.
	Interpolate	Interpolates and assigns the value corresponding to the given LERP value. (Overrides UxrTween.Interpolate(Single).)
	RestoreOriginalValue	Restores the animated component to the state before the animation started. (Overrides UxrTween.RestoreOriginalValue().)
	StoreOriginalValue	Stores the original value before the animation, in order to be able to restore it later using RestoreOriginalValue(). (Overrides UxrTween.StoreOriginalValue().)

Extension Methods

	Name	Description
	CheckSetEnabled	Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
	GetOrAddComponent<T>	Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
	GetPathUnderScene	Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
	GetSceneUid	Gets an unique identifier string for the given component. (Defined by ComponentExt.)
	GetUniqueScenePath	Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
	LoopCoroutine	Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
	SafeGetComponentInParent<T>	Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
	ShowInInspector(Boolean)	Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
	ShowInInspector(Boolean, Boolean)	Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)