Skip to main content

SpringObject

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

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.

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": 29,
                "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": 64,
                "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": 72,
                "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": 107,
                "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": 129,
                "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": 140,
                "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": 150,
                "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": 255,
                "path": "src/blend/src/Shared/Blend/SpringObject.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SpringObject",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/blend/src/Shared/Blend/SpringObject.lua"
    }
}