Show raw api
{
"functions": [
{
"name": "new",
"desc": "Constructs a new camera state tweener",
"params": [
{
"name": "serviceBagOrCameraStack",
"desc": "Service bag to find the CameraStackService in",
"lua_type": "ServiceBag | CameraStack"
},
{
"name": "cameraEffect",
"desc": "A camera effect",
"lua_type": "CameraLike"
},
{
"name": "speed",
"desc": "Speed that the camera tweener tweens at. Defaults to 20",
"lua_type": "number?"
}
],
"returns": [
{
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"function_type": "static",
"source": {
"line": 52,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "isCameraStateTweener",
"desc": "Returns true if it's a camera state tweener",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 117,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "GetPercentVisible",
"desc": "Returns percent visible, from 0 to 1.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 125,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "IsFinishedHiding",
"desc": "Returns true if we're done hiding",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"deprecated": {
"version": "14.52.0",
"desc": "Use TransitionModel.IsHidingComplete"
},
"source": {
"line": 135,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "IsFinishedShowing",
"desc": "Returns true if we're done showing",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"deprecated": {
"version": "14.52.0",
"desc": "Use TransitionModel.IsShowingComplete"
},
"source": {
"line": 145,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "Finish",
"desc": "Hides the tweener, and invokes the callback once the tweener\nis finished hiding.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
},
{
"name": "doNotAnimate",
"desc": "Optional, defaults to animating",
"lua_type": "boolean?"
},
{
"name": "callback",
"desc": "",
"lua_type": "function"
}
],
"returns": [],
"function_type": "static",
"deprecated": {
"version": "14.52.0",
"desc": "Use TransitionModel.PromiseHide, which also surfaces the tween being interrupted"
},
"source": {
"line": 157,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "GetCameraEffect",
"desc": "Gets the current effect we're tweening",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "CameraEffect"
}
],
"function_type": "static",
"source": {
"line": 167,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "GetCameraBelow",
"desc": "Gets the camera below this camera on the camera stack",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "CameraEffect"
}
],
"function_type": "static",
"source": {
"line": 175,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "SetEpsilon",
"desc": "Sets the epsilon to stop animating",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
},
{
"name": "epsilon",
"desc": "",
"lua_type": "number?"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 183,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "SetShownTarget",
"desc": "Sets how far the camera effect fades in when shown. Defaults to 1, fully faded in.\n\nChanging this while shown retargets the fade and runs the show transition again, so\n[TransitionModel.ShowingComplete] fires for the transition that actually happened.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
},
{
"name": "shownTarget",
"desc": "",
"lua_type": "number | Observable<number> | ValueObject<number>"
}
],
"returns": [
{
"desc": "Cleanup function",
"lua_type": "function"
}
],
"function_type": "static",
"source": {
"line": 196,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "GetShownTarget",
"desc": "Gets how far the camera effect fades in when shown.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 207,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "ObserveShownTarget",
"desc": "Observes how far the camera effect fades in when shown.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 215,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "SetTarget",
"desc": "Sets the percent visible target.\n\nA target of 0 hides the tweener and leaves the shown target alone, so a later\n[BasicPane.Show] returns to where it was. Any other target becomes the new shown\ntarget and shows the tweener.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
},
{
"name": "target",
"desc": "",
"lua_type": "number"
},
{
"name": "doNotAnimate",
"desc": "Optional, defaults to animating",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "self",
"lua_type": "CameraStateTweener"
}
],
"function_type": "static",
"source": {
"line": 230,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "SetSpeed",
"desc": "Sets the speed of transition",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
},
{
"name": "speed",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "self",
"lua_type": "CameraStateTweener"
}
],
"function_type": "static",
"source": {
"line": 252,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
},
{
"name": "GetFader",
"desc": "Retrieves the fading camera being used to interpolate.",
"params": [
{
"name": "self",
"desc": "",
"lua_type": "CameraStateTweener"
}
],
"returns": [
{
"desc": "",
"lua_type": "CameraEffect"
}
],
"function_type": "static",
"source": {
"line": 264,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
}
],
"properties": [],
"types": [],
"name": "CameraStateTweener",
"desc": "Makes transitions between states easier. Uses the `CameraStackService` to tween in and\nout a new camera state. Call `:Show()` and `:Hide()` to do so, and make sure to\ncall `:Destroy()` after usage.\n\nInherits from [TransitionModel]. See for more API.",
"source": {
"line": 11,
"path": "src/camera/src/Client/Utility/CameraStateTweener.lua"
}
}