Skip to main content

CameraStack

Functions​

new​

</>
CameraStack.new() → CameraStack

Constructs a new camera stack

isCameraStack​

</>
CameraStack.isCameraStack(value: any) → boolean

PushDisable​

</>
CameraStack:PushDisable() → function--

Function to cancel disable

Pushes a disable state onto the camera stack

PrintCameraStack​

</>
CameraStack:PrintCameraStack() → ()

Outputs the camera stack. Intended for diagnostics.

GetTopCamera​

</>
CameraStack:GetTopCamera() → CameraEffect

Gets the camera current on the top of the stack

GetTopState​

</>
CameraStack:GetTopState() → CameraState?

Retrieves the top state off the stack at this time

GetNewStateBelow​

</>
CameraStack:GetNewStateBelow() → (
CustomCameraEffect,--

Effect below

(CameraState) → ()--

Function to set the state

)

Returns a new camera state that retrieves the state below its set state.

GetIndex​

</>
CameraStack:GetIndex(state: CameraEffect) → number?--

index

Retrieves the index of a state

GetStack​

</>
CameraStack:GetStack() → {CameraState<T>}

Returns the current stack.

warning

Do not modify this stack, this is the raw memory of the stack

Remove​

</>
CameraStack:Remove(state: CameraState) → ()

Removes the state from the stack

Add​

</>
CameraStack:Add(state: CameraState) → ()

Adds the state from the stack

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new camera stack",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraStack"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "isCameraStack",
            "desc": "",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "PushDisable",
            "desc": "Pushes a disable state onto the camera stack",
            "params": [],
            "returns": [
                {
                    "desc": "Function to cancel disable",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 43,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "PrintCameraStack",
            "desc": "Outputs the camera stack. Intended for diagnostics.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 57,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "GetTopCamera",
            "desc": "Gets the camera current on the top of the stack",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraEffect"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 69,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "GetTopState",
            "desc": "Retrieves the top state off the stack at this time",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CameraState?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "GetNewStateBelow",
            "desc": "Returns a new camera state that retrieves the state below its set state.",
            "params": [],
            "returns": [
                {
                    "desc": "Effect below",
                    "lua_type": "CustomCameraEffect"
                },
                {
                    "desc": "Function to set the state",
                    "lua_type": "(CameraState) -> ()"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "GetIndex",
            "desc": "Retrieves the index of a state",
            "params": [
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "CameraEffect"
                }
            ],
            "returns": [
                {
                    "desc": "index",
                    "lua_type": "number?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 141,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "GetStack",
            "desc": "Returns the current stack.\n\n:::warning\nDo not modify this stack, this is the raw memory of the stack\n:::",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ CameraState<T> }"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 160,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "Remove",
            "desc": "Removes the state from the stack",
            "params": [
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "CameraState"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 170,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        },
        {
            "name": "Add",
            "desc": "Adds the state from the stack",
            "params": [
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "CameraState"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 184,
                "path": "src/camera/src/Client/CameraStack.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CameraStack",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/camera/src/Client/CameraStack.lua"
    }
}