Skip to main content

DepthOfFieldModifier

Properties​

Removing​

</>
DepthOfFieldModifier.Removing: Signal

Fires when the modifier is removing.

DistanceChanged​

</>
DepthOfFieldModifier.DistanceChanged: Signal

Fires when the distance changes.

RadiusChanged​

</>
DepthOfFieldModifier.RadiusChanged: Signal

Fires when the radius changes.

Functions​

SetDistance​

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

Sets the target depth of field distance

SetRadius​

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

Sets the target depth of field distance

GetDistance​

</>
DepthOfFieldModifier:GetDistance() → number

Retrieves the distance

GetRadius​

</>
DepthOfFieldModifier:GetRadius() → number

Retrieves the radius

Reset​

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

Resets the radius

Show raw api
{
    "functions": [
        {
            "name": "SetDistance",
            "desc": "Sets the target depth of field distance",
            "params": [
                {
                    "name": "distance",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 73,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "SetRadius",
            "desc": "Sets the target depth of field distance",
            "params": [
                {
                    "name": "radius",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 96,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "GetDistance",
            "desc": "Retrieves the distance",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 133,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "GetRadius",
            "desc": "Retrieves the radius",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 141,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "Reset",
            "desc": "Resets the radius",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 157,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "Removing",
            "desc": "Fires when the modifier is removing.",
            "lua_type": "Signal",
            "source": {
                "line": 37,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "DistanceChanged",
            "desc": "Fires when the distance changes.",
            "lua_type": "Signal",
            "source": {
                "line": 48,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        },
        {
            "name": "RadiusChanged",
            "desc": "Fires when the radius changes.",
            "lua_type": "Signal",
            "source": {
                "line": 56,
                "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
            }
        }
    ],
    "types": [],
    "name": "DepthOfFieldModifier",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/depthoffield/src/Client/DepthOfFieldModifier.lua"
    }
}