diff --git a/docs/api/animation.md b/docs/api/animation.md index b7e8ac5..3e27322 100644 --- a/docs/api/animation.md +++ b/docs/api/animation.md @@ -51,21 +51,21 @@ Returns a new source with a value always moving torwards the input source value. # tween -A small TweenService wrapper that provides ergonomic tweening helpers and optional presets. + A small TweenService wrapper that provides ergonomic tweening helpers and optional presets. -This module is designed for UI animations (size, position, transparency, colour, etc.). It is safe to `require` in non-Roblox environments (it should fall back to applying goals instantly). + This module is designed for UI animations (size, position, transparency, colour, etc.). It is safe to `require` in non-Roblox environments (it should fall back to applying goals instantly). -## Exports + ## Exports -- `vide.tween.tweenTo(instance, goals, tweenInfo?) -> Tween?` -- `vide.tween.tween(goals, tweenInfo?) -> Action` (optional, if you implemented the Action form) -- `vide.tween.presets` (optional) + - `vide.tween.tweenTo(instance, goals, tweenInfo?) -> Tween?` + - `vide.tween.tween(goals, tweenInfo?) -> Action` (optional, if you implemented the Action form) + - `vide.tween.presets` (optional) -## tweenTo() + ## tweenTo() -Tweens an instance to a set of goal properties. + Tweens an instance to a set of goal properties. -### Type + ### Type -```lua -tweenTo(instance: Instance, goals: { [string]: any }, tweenInfo: TweenInfo?) -> Tween? + ```lua + tweenTo(instance: Instance, goals: { [string]: any }, tweenInfo: TweenInfo?) -> Tween?