Skip to main content

BaseCast

This item is only intended to be used by the module's authors. Private

Base class for all Raycast operations.

Functions​

Init​

</>
BaseCast.Init(
BindableOutput: BindableEvent,--

The BindableEvent used for outputting events.

Data: any--

Configuration data for the BaseCast.

) → BaseCast--

The initialized BaseCast instance.

To initialize a new BaseCast instance.

Raycast​

</>
BaseCast:Raycast(
Origin: Vector3,--

The origin of the raycast.

Direction: Vector3,--

The direction of the raycast.

Velocity: Vector3 | number,--

The velocity of the raycast.

Behavior: FastCastBehavior,--

The behavior data for the raycast.

GUID: string--

The unique identifier for the raycast.

) → ()

Create a raycast.

SetFastCastEventsModule​

</>
BaseCast:SetFastCastEventsModule(
moduleScript: ModuleScript--

The FastCastEventsModule to set.

) → ()

Blockcast​

</>
BaseCast:Blockcast(
Origin: Vector3,--

The origin of the blockcast.

Size: Vector3,--

The size of the blockcast.

Direction: Vector3,--

The direction of the blockcast.

Velocity: Vector3 | number,--

The velocity of the blockcast.

Behavior: FastCastBehavior--

The behavior data for the blockcast.

) → ()

Create a Blockcast.

Spherecast​

</>
BaseCast:Spherecast(
Origin: Vector3,--

The origin of the spherecast.

Radius: number,--

The radius of the spherecast.

Direction: Vector3,--

The direction of the spherecast.

Velocity: Vector3 | number,--

The velocity of the spherecast.

Behavior: FastCastBehavior--

The behavior data for the spherecast.

) → ()

Create a Spherecast.

BindBulkMoveTo​

</>
BaseCast:BindBulkMoveTo(
bool: boolean--

Whether to enable or disable BulkMoveTo.

) → ()

Enables or disables the BulkMoveTo feature.

BindObjectCache​

</>
BaseCast:BindObjectCache(
bool: boolean--

Whether to enable or disable ObjectCache.

) → ()

Enables or disables the ObjectCache feature.

Destroy​

</>
BaseCast:Destroy() → ()

Destroys the BaseCast instance and cleans up resources.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "To initialize a new BaseCast instance.",
            "params": [
                {
                    "name": "BindableOutput",
                    "desc": "The BindableEvent used for outputting events.",
                    "lua_type": "BindableEvent"
                },
                {
                    "name": "Data",
                    "desc": "Configuration data for the BaseCast.",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "The initialized BaseCast instance.",
                    "lua_type": "BaseCast"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 99,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "Raycast",
            "desc": "Create a raycast.",
            "params": [
                {
                    "name": "Origin",
                    "desc": "The origin of the raycast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Direction",
                    "desc": "The direction of the raycast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Velocity",
                    "desc": "The velocity of the raycast.",
                    "lua_type": "Vector3 | number"
                },
                {
                    "name": "Behavior",
                    "desc": "The behavior data for the raycast.",
                    "lua_type": "FastCastBehavior"
                },
                {
                    "name": "GUID",
                    "desc": "The unique identifier for the raycast.",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 166,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "SetFastCastEventsModule",
            "desc": "",
            "params": [
                {
                    "name": "moduleScript",
                    "desc": "The FastCastEventsModule to set.",
                    "lua_type": "ModuleScript"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 204,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "Blockcast",
            "desc": "Create a Blockcast.",
            "params": [
                {
                    "name": "Origin",
                    "desc": "The origin of the blockcast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Size",
                    "desc": "The size of the blockcast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Direction",
                    "desc": "The direction of the blockcast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Velocity",
                    "desc": "The velocity of the blockcast.",
                    "lua_type": "Vector3 | number"
                },
                {
                    "name": "Behavior",
                    "desc": "The behavior data for the blockcast.",
                    "lua_type": "FastCastBehavior"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 230,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "Spherecast",
            "desc": "Create a Spherecast.",
            "params": [
                {
                    "name": "Origin",
                    "desc": "The origin of the spherecast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Radius",
                    "desc": "The radius of the spherecast.",
                    "lua_type": "number"
                },
                {
                    "name": "Direction",
                    "desc": "The direction of the spherecast.",
                    "lua_type": "Vector3"
                },
                {
                    "name": "Velocity",
                    "desc": "The velocity of the spherecast.",
                    "lua_type": "Vector3 | number"
                },
                {
                    "name": "Behavior",
                    "desc": "The behavior data for the spherecast.",
                    "lua_type": "FastCastBehavior"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 274,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "BindBulkMoveTo",
            "desc": "Enables or disables the BulkMoveTo feature.",
            "params": [
                {
                    "name": "bool",
                    "desc": "Whether to enable or disable BulkMoveTo.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 314,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "BindObjectCache",
            "desc": "Enables or disables the ObjectCache feature.",
            "params": [
                {
                    "name": "bool",
                    "desc": "Whether to enable or disable ObjectCache.",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 337,
                "path": "src/FastCast2/BaseCast.luau"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the BaseCast instance and cleans up resources.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 362,
                "path": "src/FastCast2/BaseCast.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "BaseCast",
    "desc": "Base class for all Raycast operations.",
    "private": true,
    "source": {
        "line": 32,
        "path": "src/FastCast2/BaseCast.luau"
    }
}