Skip to main content

TimedTween

Tween that is a specific time, useful for countdowns and other things

Functions​

new​

</>
TimedTween.new(
transitionTime: number?--

Optional

) → TimedTween

Timed transition module

SetTransitionTime​

</>
TimedTween.SetTransitionTime(
self: TimedTween,
transitionTime: number | Observable<number>
) → MaidTask

Sets the transition time

GetTransitionTime​

</>
TimedTween.GetTransitionTime(self: TimedTween) → number

Gets the transition time

ObserveTransitionTime​

</>
TimedTween.ObserveTransitionTime(self: TimedTween) → Observable<number>

Observes the transition time

ObserveRenderStepped​

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

Observes how far into the transition we are, from 0 to 1

ObserveOnSignal​

</>
TimedTween.ObserveOnSignal(
self: TimedTween,
signal: Signal
) → Observable<number>

Observes the transition on a specific signal

Observe​

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

Observes the transition

PromiseFinished​

</>
TimedTween.PromiseFinished(self: TimedTween) → Promise

Promises when the tween is finished

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Timed transition module",
            "params": [
                {
                    "name": "transitionTime",
                    "desc": "Optional",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "SetTransitionTime",
            "desc": "Sets the transition time",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                },
                {
                    "name": "transitionTime",
                    "desc": "",
                    "lua_type": "number | Observable<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "GetTransitionTime",
            "desc": "Gets the transition time",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "ObserveTransitionTime",
            "desc": "Observes the transition time",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes how far into the transition we are, from 0 to 1",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "ObserveOnSignal",
            "desc": "Observes the transition on a specific signal",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                },
                {
                    "name": "signal",
                    "desc": "",
                    "lua_type": "Signal"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Observes the transition",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 151,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        },
        {
            "name": "PromiseFinished",
            "desc": "Promises when the tween is finished",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "TimedTween"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 160,
                "path": "src/timedtween/src/Shared/TimedTween.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TimedTween",
    "desc": "Tween that is a specific time, useful for countdowns and other things",
    "source": {
        "line": 7,
        "path": "src/timedtween/src/Shared/TimedTween.lua"
    }
}