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
vide/docs/api/animation.md
aaron cb002f4f27 Initial commit
2023-08-08 21:33:11 +01:00

1.1 KiB
Raw Blame History

Animation API

spring()

Returns a new state with a dynamically animated value of the source.

  • Type

    function spring<T>(
    source: () -> T & Animatable,
    period: number = 1,
    damping_ratio: number = 1
): () -> T

type Animatable = number | CFrame | Color3 | UDim | UDim2 | Vector2 | Vector3

  • Details

    The output state value is updated every frame based on the source state value.

    The change is physically simulated according to a spring.

    period is the amount of time in seconds it takes for the spring to complete one full oscillation.

    damping_ratio is the amount of resistance applied to the spring.

    • >1 = Overdamped (not currently supported).
    • 1 = Critically damped - reaches target without any overshoot.
    • <1 = Underdamped - reaches target with some overshoot.
    • 0 = Undamped - never stabilizes, oscillates forever.

    Velocity is conserved between source state updates for smooth animation.