VRCTween

V · EThis is an official VRChat information page!

It is reviewed and approved by the VRCWiki Team. Learn how to contribute to this page by reading the Contribution Guide.

VRCTween is a SDK class that provides tweening functionality for worlds. It allows creators to smoothly animate properties such as positions, rotations, floats, vectors, and quaternions without requiring update loops or Unity animations.

Overview

A demonstration of a VRCTween, and its features. (Animated GIF)

Tweening (short for "in-betweening") is the process of generating intermediate frames between keyframes to create smooth animations. VRChat worlds can already achieve tweening through Unity animations or Udon scripts, but these approaches often require significant manual work. VRCTween is designed to make this more convenient by providing dedicated nodes and events.

VRCTween uses DOTween as the underlying library and brings much of the same functionality to VRChat.

Usage

An example of code for VRCTween, within the Udon Graph.

VRCTween methods can be used in both the Udon Node Graph and UdonSharp. Methods such as TweenPosition start an asynchronous tween and return a tween ID. The OnComplete method can register a callback event that fires when the tween finishes.

VRCTween supports easing functions (e.g. VRCTween.Ease.IN_OUT_SINE) to control the interpolation curve. The initial release does not support arbitrary animation curves, but supports all the ease types that DOTween provides (Linear, Sine, Quad, Cubic, Quart, Quint, Expo, Circ, Elastic, Back, Bounce).

Full documentation can be found here.