Skip to main content

Raycaster

Repeats raycasting attempts while ignoring items via a filter function

Types​

RaycastData​

</>
interface RaycastData {
Part: Instance
Position: Vector3
Normal: Vector3
Material: Enum.Material
}

Raycast data used by filter functions of the Raycaster.

Properties​

IgnoreList​

This item is read only and cannot be modified. Read Only
</>
Raycaster.IgnoreList: {Instance}

Current ignore list

Filter​

</>
Raycaster.Filter: function

The current filter function

IgnoreWater​

</>
Raycaster.IgnoreWater: boolean

Whether or not to ignore water

MaxCasts​

</>
Raycaster.MaxCasts: number

Total number of casts allowed

Functions​

new​

</>
Raycaster.new(
doIgnoreFunction: (data: RaycastData) → boolean--

Returns true to ignore

) → ()

Constructs a new Raycaster.

Ignore​

</>
Raycaster:Ignore(tableOrInstance: Instance | {Instance}) → ()

Ignores the value

FindPartOnRay​

</>
Raycaster:FindPartOnRay(ray: Ray) → RaycastData?

Repeats raycasts until exhausted attempts, or a result is found.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new Raycaster.",
            "params": [
                {
                    "name": "doIgnoreFunction",
                    "desc": "Returns true to ignore",
                    "lua_type": "(data: RaycastData) -> boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        },
        {
            "name": "Ignore",
            "desc": "Ignores the value",
            "params": [
                {
                    "name": "tableOrInstance",
                    "desc": "",
                    "lua_type": "Instance | { Instance }"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 44,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        },
        {
            "name": "FindPartOnRay",
            "desc": "Repeats raycasts until exhausted attempts, or a result is found.",
            "params": [
                {
                    "name": "ray",
                    "desc": "",
                    "lua_type": "Ray"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RaycastData?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "IgnoreList",
            "desc": "Current ignore list",
            "lua_type": "{ Instance }",
            "readonly": true,
            "source": {
                "line": 87,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        },
        {
            "name": "Filter",
            "desc": "The current filter function",
            "lua_type": "function",
            "source": {
                "line": 92,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        },
        {
            "name": "IgnoreWater",
            "desc": "Whether or not to ignore water",
            "lua_type": "boolean",
            "source": {
                "line": 97,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        },
        {
            "name": "MaxCasts",
            "desc": "Total number of casts allowed",
            "lua_type": "number",
            "source": {
                "line": 102,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        }
    ],
    "types": [
        {
            "name": "RaycastData",
            "desc": "Raycast data used by filter functions of the Raycaster.",
            "fields": [
                {
                    "name": "Part",
                    "lua_type": "Instance",
                    "desc": ""
                },
                {
                    "name": "Position",
                    "lua_type": "Vector3",
                    "desc": ""
                },
                {
                    "name": "Normal",
                    "lua_type": "Vector3",
                    "desc": ""
                },
                {
                    "name": "Material",
                    "lua_type": "Enum.Material",
                    "desc": ""
                }
            ],
            "source": {
                "line": 20,
                "path": "src/raycaster/src/Shared/Raycaster.lua"
            }
        }
    ],
    "name": "Raycaster",
    "desc": "Repeats raycasting attempts while ignoring items via a filter function",
    "source": {
        "line": 5,
        "path": "src/raycaster/src/Shared/Raycaster.lua"
    }
}