Skip to main content

TimedTransitionModel

Functions​

new​

</>
TimedTransitionModel.new(
transitionTime: ValueObject.Mountable<number>?--

Optional

) → TimedTransitionModel

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

isTimedTransitionModel​

</>
TimedTransitionModel.isTimedTransitionModel(value: any) → boolean

Returns true if it's a timed transition model

SetTransitionTime​

</>
TimedTransitionModel.SetTransitionTime(
transitionTime: number
) → () → ()

Sets the transition time

ObserveRenderStepped​

</>
TimedTransitionModel.ObserveRenderStepped(self: TimedTransitionModel) → Observable<number>

Observes the spring animating

Observe​

</>
TimedTransitionModel.Observe(self: TimedTransitionModel) → Observable<number>

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": "transitionTime",
                    "desc": "Optional",
                    "lua_type": "ValueObject.Mountable<number>?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "isTimedTransitionModel",
            "desc": "Returns true if it's a timed transition model",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "SetTransitionTime",
            "desc": "Sets the transition time",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                },
                {
                    "name": "transitionTime",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes the spring animating",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 77,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Alias to spring transition model observation!",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 86,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TimedTransitionModel",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
    }
}