Returns a blank `Datatype.RaycastParams` object. Unlike other data type
constructors, this constructor does not have any parameters, so you should
set its properties appropriately.

RaycastParams.new

Returns a blank `Datatype.RaycastParams`.

The `Datatype.RaycastParams` data type stores parameters for
`Class.WorldRoot:Raycast()` operations. The
`Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`
property stores an array of objects to use as either an inclusion or exclusion list
based on the `Datatype.RaycastParams.FilterType` enum. If desired, the
`Datatype.RaycastParams.IgnoreWater` property can be used to ignore
`Class.Terrain` water, and the `Datatype.RaycastParams.CollisionGroup`
property can specify a collision group for the raycasting operation.

This object is different from the similarly named `Datatype.RaycastResult`
which provides the results of a raycast.

Unlike most data types in Luau, you can change all of the members of
`Datatype.RaycastParams` without creating a new object, allowing you to reuse
the same object repeatedly.


For efficiency and simplicity, this method is the preferred way to add
instances to the filter. It has the additional advantage that it allows
`Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`
to be updated from a parallel context.


RaycastParams:AddToFilter

instances

An instance or an array containing instances to add.


Adds the instances provided to
`Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`.


RaycastParams

An array of objects whose descendants are used in filtering raycasting
candidates.


RaycastParams.FilterDescendantsInstances

Determines how the
`Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`
array is used, depending on the `Enum.RaycastFilterType` provided.


RaycastParams.FilterType

Determines how the
`Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`
array is used.


Determines whether the water material is considered when raycasting
against `Class.Terrain`.


RaycastParams.IgnoreWater

Specifies a collision group for the raycasting operation. Parts in
collision groups that are set to **not** collide with this group are
ignored. If this property is omitted, the raycast assumes the **Default**
collision group.


RaycastParams.CollisionGroup

The collision group used for the operation.


This property, if `true`, makes the raycast operation use an intersected
part's `Class.BasePart.CanCollide|CanCollide` value in favor of its
`Class.BasePart.CanQuery|CanQuery` value when determining whether that
part is included in the `Datatype.RaycastResult`.


RaycastParams.RespectCanCollide

Determines whether the raycast operation considers a part's
`Class.BasePart.CanCollide|CanCollide` property value over its
`Class.BasePart.CanQuery|CanQuery` value.


A container for parameters used in raycasting operations.


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}

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.

RaycastParams

Summary

Constructors

Properties

Methods

Constructors

new

Properties

FilterDescendantsInstances

FilterType

IgnoreWater

CollisionGroup

RespectCanCollide

Methods

AddToFilter

Parameters

Returns