Skip to main content

SpringTransitionModel

Functions​

new​

</>
SpringTransitionModel.new(
showTarget: T?,--

Defaults to 1

hideTarget: T?--

Defaults to 0*showTarget

) → SpringTransitionModel<T>

A transition model that has a spring underlying it. Very useful for animations on tracks that need to be on a spring.

isSpringTransitionModel​

</>
SpringTransitionModel.isSpringTransitionModel(value: any) → boolean

Returns true if it's a spring transition model

SetShowTarget​

</>
SpringTransitionModel.SetShowTarget(
showTarget: T?,
doNotAnimate: boolean?
) → ()

Sets the show target for the transition model

SetHideTarget​

</>
SpringTransitionModel.SetHideTarget(
hideTarget: T?,
doNotAnimate: boolean?
) → ()

Sets the hide target for the transition model

GetVelocity​

</>
SpringTransitionModel.GetVelocity(self: SpringTransitionModel<T>) → T

Returns the spring's velocity

SetEpsilon​

</>
SpringTransitionModel.SetEpsilon(
epsilon: number
) → ()

Sets the springs epsilon. This can affect how long the spring takes to finish.

SetSpeed​

</>
SpringTransitionModel.SetSpeed(
speed: number
) → ()

Sets the springs speed

SetDamper​

</>
SpringTransitionModel.SetDamper(
damper: number
) → ()

Sets the springs damper

ObserveRenderStepped​

</>
SpringTransitionModel.ObserveRenderStepped(self: SpringTransitionModel<T>) → Observable<T>

Observes the spring animating

Observe​

</>
SpringTransitionModel.Observe(self: SpringTransitionModel<T>) → Observable<T>

Alias to spring transition model observation!

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "A transition model that has a spring underlying it. Very useful\nfor animations on tracks that need to be on a spring.",
            "params": [
                {
                    "name": "showTarget",
                    "desc": "Defaults to 1",
                    "lua_type": "T?"
                },
                {
                    "name": "hideTarget",
                    "desc": "Defaults to 0*showTarget",
                    "lua_type": "T?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "isSpringTransitionModel",
            "desc": "Returns true if it's a spring transition model",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetShowTarget",
            "desc": "Sets the show target for the transition model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "showTarget",
                    "desc": "",
                    "lua_type": "T?"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetHideTarget",
            "desc": "Sets the hide target for the transition model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "hideTarget",
                    "desc": "",
                    "lua_type": "T?"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "GetVelocity",
            "desc": "Returns the spring's velocity",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetEpsilon",
            "desc": "Sets the springs epsilon. This can affect how long the spring takes\nto finish.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "epsilon",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 115,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetSpeed",
            "desc": "Sets the springs speed",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 126,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetDamper",
            "desc": "Sets the springs damper",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "damper",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 137,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes the spring animating",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Alias to spring transition model observation!",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 156,
                "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SpringTransitionModel",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/transitionmodel/src/Shared/Spring/SpringTransitionModel.lua"
    }
}