hakowork/vide
3
0
Fork 0
mirror of https://github.com/centau/vide.git synced 2026-08-20 14:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document Tween module and its functions

Browse source 
Added documentation for the Tween module, including usage and exports.
This commit is contained in:
sindri 2026-03-03 12:02:07 +01:00 • committed by GitHub
parent e6b4bb01ac
commit f706207e6e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/api/animation.md
View file

@ -48,3 +48,24 @@ Returns a new source with a value always moving torwards the input source value.
::: warning
Large periods or damping ratios can break the spring.
:::
# tween
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).
## 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)
## tweenTo()
Tweens an instance to a set of goal properties.
### Type
```lua
tweenTo(instance: Instance, goals: { [string]: any }, tweenInfo: TweenInfo?) -> Tween?