Skip to main content

RaycastUtils

General utility for raycasting Author: Quenty, AxisAngle

Functions​

raycastSingleExit​

</>
RaycastUtils.raycastSingleExit(
origin: Vector3,
direction: Vector3,
part: BasePart
) → RaycastResult

What is the first exit along this line segment?

  • Works for non-convex
  • Assumes non-selfintersecting

ignoreCanCollideFalse​

</>
RaycastUtils.ignoreCanCollideFalse(part: BasePart) → boolean

Ignore function that ignores can collide false parts.

raycast​

</>
RaycastUtils.raycast(
origin: Vector3,
direction: Vector3,
ignoreListWorkingEnvironment: {Instance},
ignoreFunc: callback,
keepIgnoreListChanges: boolean?,
ignoreWater: boolean?
) → RaycastResult

Raycasts from a given point and repeatedly raycasts until the ignore function does not apply.

Show raw api
{
    "functions": [
        {
            "name": "raycastSingleExit",
            "desc": "What is the first exit along this line segment?\n\n* Works for non-convex\n* Assumes non-selfintersecting",
            "params": [
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "direction",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RaycastResult"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/raycaster/src/Shared/RaycastUtils.lua"
            }
        },
        {
            "name": "ignoreCanCollideFalse",
            "desc": "Ignore function that ignores can collide false parts.",
            "params": [
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/raycaster/src/Shared/RaycastUtils.lua"
            }
        },
        {
            "name": "raycast",
            "desc": "Raycasts from a given point and repeatedly raycasts until the ignore function\ndoes not apply.",
            "params": [
                {
                    "name": "origin",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "direction",
                    "desc": "",
                    "lua_type": "Vector3"
                },
                {
                    "name": "ignoreListWorkingEnvironment",
                    "desc": "",
                    "lua_type": "{ Instance }"
                },
                {
                    "name": "ignoreFunc",
                    "desc": "",
                    "lua_type": "callback"
                },
                {
                    "name": "keepIgnoreListChanges",
                    "desc": "",
                    "lua_type": "boolean?"
                },
                {
                    "name": "ignoreWater",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RaycastResult"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/raycaster/src/Shared/RaycastUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RaycastUtils",
    "desc": "General utility for raycasting\nAuthor: Quenty, AxisAngle",
    "source": {
        "line": 7,
        "path": "src/raycaster/src/Shared/RaycastUtils.lua"
    }
}