createTweenAnimation
Creates a tween animation by Float value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Vector2 value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Vector3 value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Vector4 value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Transform value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Quat value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by EulerAngles value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Color4 value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
Creates a tween animation by Color3 value.
Return
The created TweenAnimation.
Parameters
The name of the animation, no more than 63 ascii characters. The default value is an empty string "".
The target to be animated. Default is null.
The from value.
The to value.
The by value.
The total playback duration of the animation, in seconds. Must be greater than 0. The default value is 1F (1 second).
The amount of seconds the animation delays before starting to be played. Must be greater than or equal to 0. The default value is 0F (0 second).
How an animation behaves when it reaches the end of one playback. An animation's repeatCount must be set to a positive integer or '-1' for this property to work. The Default value is RepeatMode.NONE.
How many times an animation is repeated. Use INFINITE to repeat indefinitely, or a non-negative integer. For example, a value of 1 means that the animation is repeated once after the initial playback ends, so the animation plays a total of two times. The default value is 0, which means no repetition.
The ease type of the animation. The default value is EaseType.LINEAR.
The offset for the start time of the animation's playback, in seconds. Must be greater than or equal to 0. The default value is 0F (0 second).
A factor that increases or decreases the animation’s playback speed. Must be greater than 0. The default value is 1F (1x speed).
Whether to add the data of this animation to the animation that is currently playing. The default value is false.
The start time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The end time of the trimmed animation segment, in seconds. Must be greater than or equal to 0 if specified. The default value is null.
The duration of the animation to trim, in seconds. Must be greater than or equal to 0 if specified. The default value is null.