🔍 Trace
Trace a ray against the world and get collided objects information.
🗿Static Class
This is a Static Class. Access it's methods directly with
.. It's not possible to spawn new instances.💂Authority
This static class can be accessed only on 🟧 Client side.
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
🗿 Static Functions
| Returns | Name | Description | |
|---|---|---|---|
 | table of table | BoxMulti | Trace a box against the world using object types and return overlapping hits and then first blocking hit |
| table | BoxSingle | Trace a box against the world and returns a table with the first blocking hit information |
| table of table | CapsuleMulti | Trace a capsule against the world using object types and return overlapping hits and then first blocking hit |
| table | CapsuleSingle | Trace a capsule against the world and returns a table with the first blocking hit information |
| table of table | LineMulti | Trace a ray against the world using object types and return overlapping hits and then first blocking hit |
| table | LineSingle | Trace a ray against the world and returns a table with the first blocking hit information |
| table of table | SphereMulti | Trace a sphere against the world using object types and return overlapping hits and then first blocking hit |
| table | SphereSingle | Trace a sphere against the world and returns a table with the first blocking hit information |
BoxMulti
Trace a box against the world using object types and return overlapping hits and then first blocking hit
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
Results are sorted, so a blocking hit (if found) will be the last element of the array
Only the single closest blocking result will be generated, no tests will be done after that
— Returns table of table (with this format).
local ret = Trace.BoxMulti(start_location, end_location, half_size, orientation, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the box |
| Vector | end_location | Required parameter | End location of the box |
| Vector | half_size | Required parameter | Distance from the center of box along each axis |
| Rotator | orientation | Required parameter | Orientation of the box |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
BoxSingle
Trace a box against the world and returns a table with the first blocking hit information
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
— Returns table (with this format).
local ret = Trace.BoxSingle(start_location, end_location, half_size, orientation, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the box |
| Vector | end_location | Required parameter | End location of the box |
| Vector | half_size | Required parameter | Distance from the center of box along each axis |
| Rotator | orientation | Required parameter | Orientation of the box |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
CapsuleMulti
Trace a capsule against the world using object types and return overlapping hits and then first blocking hit
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
Results are sorted, so a blocking hit (if found) will be the last element of the array
Only the single closest blocking result will be generated, no tests will be done after that
— Returns table of table (with this format).
local ret = Trace.CapsuleMulti(start_location, end_location, radius, half_height, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the capsule |
| Vector | end_location | Required parameter | End location of the capsule |
| float | radius | Required parameter | Radius of the capsule to sweep |
| float | half_height | Required parameter | Distance from center of capsule to tip of hemisphere endcap. |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
CapsuleSingle
Trace a capsule against the world and returns a table with the first blocking hit information
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
— Returns table (with this format).
local ret = Trace.CapsuleSingle(start_location, end_location, radius, half_height, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the capsule |
| Vector | end_location | Required parameter | End location of the capsule |
| float | radius | Required parameter | Radius of the capsule to sweep |
| float | half_height | Required parameter | Distance from center of capsule to tip of hemisphere endcap. |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
LineMulti
Trace a ray against the world using object types and return overlapping hits and then first blocking hit
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
Results are sorted, so a blocking hit (if found) will be the last element of the array
Only the single closest blocking result will be generated, no tests will be done after that
— Returns table of table (with this format).
local ret = Trace.LineMulti(start_location, end_location, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the ray |
| Vector | end_location | Required parameter | End location of the ray |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
LineSingle
Trace a ray against the world and returns a table with the first blocking hit information
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
— Returns table (with this format).
local ret = Trace.LineSingle(start_location, end_location, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the ray |
| Vector | end_location | Required parameter | End location of the ray |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
SphereMulti
Trace a sphere against the world using object types and return overlapping hits and then first blocking hit
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
Results are sorted, so a blocking hit (if found) will be the last element of the array
Only the single closest blocking result will be generated, no tests will be done after that
— Returns table of table (with this format).
local ret = Trace.SphereMulti(start_location, end_location, radius, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the sphere |
| Vector | end_location | Required parameter | End location of the sphere |
| float | radius | Required parameter | Radius of the sphere |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |
SphereSingle
Trace a sphere against the world and returns a table with the first blocking hit information
Note: The Trace will collide with the ObjectType (in the Collision Settings), even if the channel is ignored below.
— Returns table (with this format).
local ret = Trace.SphereSingle(start_location, end_location, radius, collision_channel?, trace_mode?, ignored_actors?)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | Start location of the sphere |
| Vector | end_location | Required parameter | End location of the sphere |
| float | radius | Required parameter | Radius of the sphere |
| CollisionChannel | collision_channel? | WorldStatic | Supports several channels separating by | (using bit-wise operations) |
| TraceMode | trace_mode? | 0 | Trace Mode, pass all parameters separating by | (using bit-wise operations)You need to explicitily pass the modes to return the values you want |
| table of Base Actor | ignored_actors? | {} | Array of actors to ignore during the trace |