The `Datatype.RaycastResult` data type stores the result of a successful
raycasting operation performed by `Class.WorldRoot:Raycast()`. It contains the
properties listed below.

This object should not be confused with the similarly-named
`Datatype.RaycastParams` which is used to perform a raycast.


RaycastResult

The distance between the ray origin and the intersection point.


RaycastResult.Distance

The `Class.BasePart` or `Class.Terrain` cell that the ray intersected.


RaycastResult.Instance

The `Enum.Material` at the intersection point. For normal parts this is
the `Class.BasePart.Material`; for `Class.Terrain` this can vary depending
on terrain data.


RaycastResult.Material

The `Enum.Material` at the intersection point.


The world space point at which the intersection occurred, usually a point
directly on the surface of the instance.


RaycastResult.Position

The position of the intersection between the ray and the part.


The normal vector of the intersected face.


RaycastResult.Normal

Stores results from a raycast operation.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

Unable to add to inventory

The code sample {title} has been added to your Inventory.

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

RaycastResult

Summary

Properties

Properties

Distance

Instance

Material

Position

Normal