Skip to main content

ClientCast

The constructor class for ClientCaster objects.

Types​

Settings​

</>
interface Settings {
AttachmentName: string
DebugAttachmentName: string
FunctionDebug: boolean
DebugMode: boolean
DebugColor: Color3
DebugLifetime: number
AutoSetup: boolean
}

The settings which ClientCast relies on for module behavior.

Properties​

Settings​

</>
ClientCast.Settings: Settings

Functions​

new​

</>
ClientCast.new(
Object: Instance,
RaycastParameters: RaycastParams,
NetworkOwner: Player
) → ClientCaster
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "Object",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "RaycastParameters",
                    "desc": "",
                    "lua_type": "RaycastParams"
                },
                {
                    "name": "NetworkOwner",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ClientCaster"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 514,
                "path": "lib/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Settings",
            "desc": "",
            "lua_type": "Settings",
            "source": {
                "line": 23,
                "path": "lib/init.luau"
            }
        }
    ],
    "types": [
        {
            "name": "Settings",
            "desc": "The settings which ClientCast relies on for module behavior.",
            "fields": [
                {
                    "name": "AttachmentName",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "DebugAttachmentName",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "FunctionDebug",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "DebugMode",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "DebugColor",
                    "lua_type": "Color3",
                    "desc": ""
                },
                {
                    "name": "DebugLifetime",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "AutoSetup",
                    "lua_type": "boolean",
                    "desc": ""
                }
            ],
            "source": {
                "line": 21,
                "path": "lib/init.luau"
            }
        }
    ],
    "name": "ClientCast",
    "desc": "The constructor class for ClientCaster objects.",
    "source": {
        "line": 6,
        "path": "lib/init.luau"
    }
}