Show raw api
{
"functions": [
{
"name": "new",
"desc": "A transition model that has an [AccelTween] underlying it. Reaches its target in minimum\ntime under a maximum acceleration, so unlike [SpringTransitionModel] it arrives at a\ndefinite time and never overshoots.\n\nOnly numbers are supported. [AccelTween] solves on a scalar, so there is no equivalent of\nthe linear value conversion [SpringTransitionModel] uses to animate Vector3s and Color3s.",
"params": [
{
"name": "showTarget",
"desc": "Defaults to 1",
"lua_type": "number?"
},
{
"name": "hideTarget",
"desc": "Defaults to 0",
"lua_type": "number?"
}
],
"returns": [
{
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"function_type": "static",
"source": {
"line": 49,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "isAccelTweenTransitionModel",
"desc": "Returns true if it's an accel tween transition model",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 79,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "SetShowTarget",
"desc": "Sets the show target for the transition model",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
},
{
"name": "showTarget",
"desc": "",
"lua_type": "number?"
},
{
"name": "doNotAnimate",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 89,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "SetHideTarget",
"desc": "Sets the hide target for the transition model",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
},
{
"name": "hideTarget",
"desc": "",
"lua_type": "number?"
},
{
"name": "doNotAnimate",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 111,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "SetAcceleration",
"desc": "Sets the maximum acceleration used to reach the target. Higher is faster.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
},
{
"name": "acceleration",
"desc": "",
"lua_type": "number"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 132,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "GetAcceleration",
"desc": "Gets the maximum acceleration used to reach the target",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 146,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "GetPosition",
"desc": "Returns the current position of the tween",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 155,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "GetVelocity",
"desc": "Returns the tween velocity",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 164,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "GetRemainingTime",
"desc": "Returns the time left before the tween attains its target",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 173,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "ObserveRenderStepped",
"desc": "Observes the tween animating on the animation step",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 181,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "ObserveOnSignal",
"desc": "Observes the tween animating on a specific signal",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
},
{
"name": "signal",
"desc": "",
"lua_type": "RBXScriptSignal"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 191,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "Observe",
"desc": "Alias to accel tween transition model observation!",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 216,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
},
{
"name": "_promiseFinished",
"desc": "Promises when the tween has arrived at its target.\n\n[AccelTween] solves the arrival time analytically, but that time is only meaningful against\nthe clock the tween reads, which may not be wall time. Poll it off the animation step rather\nthan scheduling against `rtime`.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "AccelTweenTransitionModel"
}
],
"returns": [
{
"desc": "",
"lua_type": "Promise"
}
],
"function_type": "static",
"private": true,
"source": {
"line": 258,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
}
],
"properties": [],
"types": [],
"name": "AccelTweenTransitionModel",
"desc": "",
"source": {
"line": 5,
"path": "src/transitionmodel/src/Shared/AccelTween/AccelTweenTransitionModel.lua"
}
}