Skip to main content

SpringObject

This is like a Spring, but it can be observed, and emits events. It handles Observables and

Properties​

Changed​

</>
SpringObject.Changed: Signal<()>--Fireswheneverthespringinitiallychangesstate

Event fires when the spring value changes

Functions​

new​

</>
SpringObject.new(
target: T,
speed: number | Observable<number> | ValueObject<number> | NumberValue | any,
damper: number | Observable<number> | NumberValue | any
) → Spring<T>

Constructs a new SpringObject.

isSpringObject​

</>
SpringObject.isSpringObject(value: any) → boolean

Returns whether an object is a SpringObject.

ObserveRenderStepped​

</>
SpringObject:ObserveRenderStepped() → Observable<T>

Observes the spring animating

Observe​

</>
SpringObject:Observe() → Observable<T>

Alias for [ObserveRenderStepped]

ObserveTarget​

</>
SpringObject:ObserveTarget() → Observable<T>

Observes the current target of the spring

PromiseFinished​

</>
SpringObject:PromiseFinished(signal: RBXScriptSignal | nil) → Observable<T>

Promises that the spring is done, based upon the animating property Relatively expensive.

ObserveOnSignal​

</>
SpringObject:ObserveOnSignal(signal: RBXScriptSignal) → Observable<T>

Observes the spring animating

IsAnimating​

</>
SpringObject:IsAnimating() → boolean--

True if animating

Returns true when we're animating

Impulse​

</>
SpringObject:Impulse(
velocity: T--

The velocity to impulse with

) → ()

Impulses the spring, increasing velocity by the amount given. This is useful to make something shake, like a Mac password box failing.

SetTarget​

</>
SpringObject:SetTarget(
value: T,--

The target to set

doNotAnimate: boolean?--

Whether or not to animate

) → ()

Sets the actual target. If doNotAnimate is set, then animation will be skipped.

TimeSkip​

</>
SpringObject:TimeSkip(
delta: number--

Time to skip forwards

) → ()

Instantly skips the spring forwards by that amount time

Destroy​

</>
SpringObject:Destroy() → ()

Cleans up the BaseObject and sets the metatable to nil

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new SpringObject.",
            "params": [
                {
                    "name": "target",
                    "desc": "",
                    "lua_type": "T"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number | Observable<number> | ValueObject<number> | NumberValue | any"
                },
                {
                    "name": "damper",
                    "desc": "",
                    "lua_type": "number | Observable<number> | NumberValue | any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Spring<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "isSpringObject",
            "desc": "Returns whether an object is a SpringObject.",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 69,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes the spring animating",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 77,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Alias for [ObserveRenderStepped]",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "ObserveTarget",
            "desc": "Observes the current target of the spring",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 99,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "PromiseFinished",
            "desc": "Promises that the spring is done, based upon the animating property\nRelatively expensive.",
            "params": [
                {
                    "name": "signal",
                    "desc": "",
                    "lua_type": "RBXScriptSignal | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "ObserveOnSignal",
            "desc": "Observes the spring animating",
            "params": [
                {
                    "name": "signal",
                    "desc": "",
                    "lua_type": "RBXScriptSignal"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 190,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "IsAnimating",
            "desc": "Returns true when we're animating",
            "params": [],
            "returns": [
                {
                    "desc": "True if animating",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 212,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "Impulse",
            "desc": "Impulses the spring, increasing velocity by the amount given. This is useful to make something shake,\nlike a Mac password box failing.",
            "params": [
                {
                    "name": "velocity",
                    "desc": "The velocity to impulse with",
                    "lua_type": "T"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 223,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "SetTarget",
            "desc": "Sets the actual target. If doNotAnimate is set, then animation will be skipped.",
            "params": [
                {
                    "name": "value",
                    "desc": "The target to set",
                    "lua_type": "T"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "Whether or not to animate",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 235,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "TimeSkip",
            "desc": "Instantly skips the spring forwards by that amount time",
            "params": [
                {
                    "name": "delta",
                    "desc": "Time to skip forwards",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 266,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the BaseObject and sets the metatable to nil",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 371,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Changed",
            "desc": "Event fires when the spring value changes",
            "lua_type": "Signal<()> -- Fires whenever the spring initially changes state",
            "source": {
                "line": 45,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        }
    ],
    "types": [],
    "name": "SpringObject",
    "desc": "This is like a [Spring], but it can be observed, and emits events. It handles [Observable]s and",
    "source": {
        "line": 6,
        "path": "src/blend/src/Shared/Blend/SpringObject.lua"
    }
}