Skip to main content

DepthOfFieldTweener

Tweens DepthOfField. Prefer to use DepthOfFieldService.

Functions​

new​

</>
DepthOfFieldTweener.new(depthOfField: number) → DepthOfFieldTweener

Create a new DepthOfFieldTweener.

SetRadius​

</>
DepthOfFieldTweener:SetRadius(
radius: number,
doNotAnimate: boolean
) → ()

Sets the radius and starts any animation

GetRadius​

</>
DepthOfFieldTweener:GetRadius() → number

Gets the current radius being rendered

GetDistance​

</>
DepthOfFieldTweener:GetDistance() → number

Gets the current distance being set

SetDistance​

</>
DepthOfFieldTweener:SetDistance(
distance: number,
doNotAnimate: boolean
) → ()

Sets the distance to render

Reset​

</>
DepthOfFieldTweener:Reset(doNotAnimate: boolean) → ()

Resets the depth of field to the original distance

ResetRadius​

</>
DepthOfFieldTweener:ResetRadius(doNotAnimate: boolean) → ()

Resets the radius

ResetDistance​

</>
DepthOfFieldTweener:ResetDistance(doNotAnimate: boolean) → ()

Resets the distance

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Create a new DepthOfFieldTweener.",
            "params": [
                {
                    "name": "depthOfField",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "DepthOfFieldTweener"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "SetRadius",
            "desc": "Sets the radius and starts any animation",
            "params": [
                {
                    "name": "radius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "GetRadius",
            "desc": "Gets the current radius being rendered",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "GetDistance",
            "desc": "Gets the current distance being set",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 118,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "SetDistance",
            "desc": "Sets the distance to render",
            "params": [
                {
                    "name": "distance",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 127,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "Reset",
            "desc": "Resets the depth of field to the original distance",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 144,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "ResetRadius",
            "desc": "Resets the radius",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 155,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        },
        {
            "name": "ResetDistance",
            "desc": "Resets the distance",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 163,
                "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DepthOfFieldTweener",
    "desc": "Tweens DepthOfField. Prefer to use [DepthOfFieldService].",
    "source": {
        "line": 5,
        "path": "src/depthoffield/src/Client/DepthOfFieldTweener.lua"
    }
}