v2.0.0

Changelog

New changes

• New: Method SetVisualUpdateInterval to limit how often the text mesh is visually updated, which can improve performance
• New: Extra tween methods
  • DODriftPosition
  • DODriftRotation
  • DOMoveCircle
    • More performant version of DOCircle
  • DOOffsetMove/X/Y/Z
    • Same behavior as v1.0.0 DOLocalMove/X/Y/Z, tweens character relative to its start poisiton. DOLocalMove/X/Y/Z now tweens character position relative to text mesh position
• New: Methods to control all tweens under a CharTweener or all tweens on a single character
  • DOCompleteAll
  • DOCompleteAll(int charIndex)
  • DOKillAll
  • DOKillAll(int charIndex)
• New: Tween methods for parity with DOTween
  • DOBlendablePunchRotation
  • DOLocalJump
• New: CharTweener getters/setters
  • GetStartPosition (character's original position)
  • GetLocalStartPosition (character's original position relative to the text mesh's position)
  • Get/SetOffsetPosition (character's current position relative to its original position)
  • Get/SetLocalScale(int charIndex, float value) (Sets x, y, and z localScale)
  • ResetPosition
  • ResetRotation
  • ResetScale
• New: CharTweener methods and getters/setters for parity with Transform
  • Get/SetLocalPosition (character's position relative to the text mesh's position)
  • GetLocalToWorldMatrix
  • GetUp/Forward/RightVector
  • GetWorldToLocalMatrix
  • InverseTransformDirection/Point/Vector
  • LookAt
  • Rotate
  • RotateAround
  • TransformDirection/Point/Vector
  • Translate
• New: Example scenes CharTweenerExampleInput and CharTweenerExampleFull
• New: CharTweener component and proxy transforms are now visible in Unity's hierarchy view, as children of the target text mesh.

Breaking changes

• Breaking change: Dependencies
  • Unity 2018.1.0f2 or newer
  • TextMesh Pro 1.3.0 (found in 2018.1.0f2 package manager) or newer
  • DOTween 1.1.695 (February 02, 2018) or newer
    • DOTween 1.2.320 (January 07, 2020) and older require small changes
• Breaking change: Ahead-of-time tweening will not work with DOLocalMoveX/Y/Z or DOMoveX/Y/Z
  • Feature should work with all other tweens, including DOOffsetMoveX/Y/Z (which was formerly DoLocalMoveX/Y/Z)
  • Ahead-of-time tweening allows for animation of characters that do not yet exist in the text
• Breaking change: Changed DOLocalMove/X/Y/Z, now tweens character position relative to text mesh position. For old DOLocalMove/X/Y/Z behavior, use new DOOffsetMove/X/Y/Z
• Breaking change: Renamed some CharTweener getters/setters
  • Get/SetPositionOffset to Get/SetPosition (#4)
  • Get/SetGradient to Get/SetColorGradient
• Breaking change: Changed CharTweener.Text access from public { get; set; } to public { get; }
• Breaking change: Changed behavior of some CharTweener getter methods on non-modified characters
  • GetColor on a non-modified character now returns the text mesh color instead of default(Color)
  • GetColorGradient (renamed from GetGradient) on a non-modified character now returns the text mesh colorGradient instead of default(VertexGradient)
  • GetPosition (renamed from GetPositionOffset) on a non-modified character now returns the character position instead of Vector3.zero
  • GetEulerAngles on a non-modified character now returns the text mesh eulerAngles instead of Vector3.zero
  • GetRotation on a non-modified character now returns the text mesh rotation instead of Quaternion.identity
  • GetLossyScale on a non-modified character now returns the text mesh lossyScale instead of Vector3.one
• Breaking change: Changed CharTweener.Initialize signature from void()
  to void(TMP_Text text)

Fixes

• Fix: Tweens not setting color correctly after multiple calls (#3)
• Fix: VertexGradientPlugin.SetFrom compile-time exception in new DOTween version (#5, #7)

v1.0.0

Stay with this release if using Unity 2017 or earlier.