Skip to main content

CustomCameraEffect

For effects that can be easily bound in scope

Properties​

CameraState​

This item is read only and cannot be modified. Read Only
</>
CustomCameraEffect.CameraState: CameraState

The current state.

Functions​

new​

</>
CustomCameraEffect.new(
getCurrentStateFunc: () → CameraState--

Custom effect generator

) → CustomCameraEffect

Constructs a new custom camera effect

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new custom camera effect",
            "params": [
                {
                    "name": "getCurrentStateFunc",
                    "desc": "Custom effect generator",
                    "lua_type": "() -> CameraState"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CustomCameraEffect"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 18,
                "path": "src/camera/src/Client/Effects/CustomCameraEffect.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "CameraState",
            "desc": "The current state.",
            "lua_type": "CameraState",
            "readonly": true,
            "source": {
                "line": 36,
                "path": "src/camera/src/Client/Effects/CustomCameraEffect.lua"
            }
        }
    ],
    "types": [],
    "name": "CustomCameraEffect",
    "desc": "For effects that can be easily bound in scope",
    "source": {
        "line": 5,
        "path": "src/camera/src/Client/Effects/CustomCameraEffect.lua"
    }
}