Skip to main content

TimedTransitionModel

Functions​

new​

</>
TimedTransitionModel.new(
transitionTime: 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.

SetTransitionTime​

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

Sets the transition time

IsShowingComplete​

</>
TimedTransitionModel.IsShowingComplete(self: TimedTransitionModel) → boolean

Returns true if showing is complete

IsHidingComplete​

</>
TimedTransitionModel.IsHidingComplete(self: TimedTransitionModel) → boolean

Returns true if hiding is complete

ObserveIsShowingComplete​

</>
TimedTransitionModel.ObserveIsShowingComplete(self: TimedTransitionModel) → Observable<boolean>

Observe is showing is complete

ObserveIsHidingComplete​

</>
TimedTransitionModel.ObserveIsHidingComplete(self: TimedTransitionModel) → Observable<boolean>

Observe is hiding is complete

BindToPaneVisbility​

</>
TimedTransitionModel.BindToPaneVisbility(
pane: BasicPane
) → function--

Cleanup function

Binds the transition model to the actual visiblity of the pane

ObserveRenderStepped​

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

Observes the spring animating

Observe​

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

Alias to spring transition model observation!

PromiseShow​

</>
TimedTransitionModel.PromiseShow(
doNotAnimate: boolean?
) → Promise

Shows the model and promises when the showing is complete.

PromiseHide​

</>
TimedTransitionModel.PromiseHide(
doNotAnimate: boolean?
) → Promise

Hides the model and promises when the showing is complete.

PromiseToggle​

</>
TimedTransitionModel.PromiseToggle(
doNotAnimate: boolean
) → Promise

Toggles the model and promises when the transition is complete.

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": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "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": [],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "IsShowingComplete",
            "desc": "Returns true if showing is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "IsHidingComplete",
            "desc": "Returns true if hiding is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 74,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsShowingComplete",
            "desc": "Observe is showing is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 82,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsHidingComplete",
            "desc": "Observe is hiding is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 90,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "BindToPaneVisbility",
            "desc": "Binds the transition model to the actual visiblity of the pane",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                },
                {
                    "name": "pane",
                    "desc": "",
                    "lua_type": "BasicPane"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup function",
                    "lua_type": "function"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "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": 129,
                "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": 138,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseShow",
            "desc": "Shows the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 148,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseHide",
            "desc": "Hides the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 158,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseToggle",
            "desc": "Toggles the model and promises when the transition is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTransitionModel"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TimedTransitionModel",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
    }
}