Returns a new `Datatype.Ray` with given `Origin` and `Direction`.

Ray.new

Origin

Direction

Returns a `Datatype.Ray` with the given `Origin` and `Direction`.

The `Datatype.Ray` data type represents a half-line, finite in one direction
but infinite in the other. It can be defined by a 3D point, where the line
originates from, and a direction vector, which is the direction it goes in.


Returns a `Datatype.Vector3` projected onto the ray so that it is within
the `Datatype.Ray`'s line of sight.

**Note:** the `Datatype.Ray` **must** be a unit ray for this method to
behave as expected!


Ray:ClosestPoint

point

Returns a `Datatype.Vector3` projected onto the ray so that it is within
the `Datatype.Ray`'s line of sight.


Returns the distance between the given point and the point on the ray
nearest to the given point (`Datatype.Ray.ClosestPoint(point)`).


Ray:Distance

Returns the distance between the given point and the closest point on the
`Datatype.Ray`.


The `Datatype.Ray` with a normalized direction (the direction has a
magnitude of `1`).


Ray.Unit

Ray.Origin

The direction vector of the `Datatype.Ray`.


Ray.Direction

Represents a line with a starting point that casts infinitely in a specific
direction.


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.

Ray

Summary

Constructors

Properties

Methods

Constructors

new

Parameters

Properties

Unit

Origin

Direction

Methods

ClosestPoint

Parameters

Returns

Distance

Parameters

Returns