Skip to main content

OverrideDefaultCameraToo

Allows you to override the default camera with this cameras information. Useful for custom camera controls that the user controls. 

local overrideDefaultCamera = OverrideDefaultCameraToo.new(effect, self._cameraStackService:GetRawDefaultCamera())
overrideDefaultCamera.Predicate = function()
	return self._cameraStateTweener:IsFinishedShowing()
end

Functions​

new​

</>
OverrideDefaultCameraToo.new(
baseCamera: Camera,
defaultCamera: DefaultCamera,
predicate: Filteronwhethertooverrideornot
) → ()

Initializes a new OverrideDefaultCameraToo

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Initializes a new OverrideDefaultCameraToo",
            "params": [
                {
                    "name": "baseCamera",
                    "desc": "",
                    "lua_type": "Camera"
                },
                {
                    "name": "defaultCamera",
                    "desc": "",
                    "lua_type": "DefaultCamera"
                },
                {
                    "name": "predicate",
                    "desc": "",
                    "lua_type": "Filter on whether to override or not"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 31,
                "path": "src/camera/src/Client/Effects/OverrideDefaultCameraToo.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "OverrideDefaultCameraToo",
    "desc": "Allows you to override the default camera with this cameras\ninformation. Useful for custom camera controls that the user\ncontrols.\n\n```lua\nlocal overrideDefaultCamera = OverrideDefaultCameraToo.new(effect, self._cameraStackService:GetRawDefaultCamera())\noverrideDefaultCamera.Predicate = function()\n\treturn self._cameraStateTweener:IsFinishedShowing()\nend\n```",
    "source": {
        "line": 15,
        "path": "src/camera/src/Client/Effects/OverrideDefaultCameraToo.lua"
    }
}