s&box docs
API Referenceglobal

public sealed struct Ray

A struct describing an origin and direction

Broader workflow and conceptual references connected to this API.

Component Interfaces

There are various interfaces that can be given to components for specific purposes.

Screen Space Tracing

ScreenSpace::Trace provides functionality for tracing rays in screen space to compute effects like Dynamic Reflections or any kind of ray in world space. It leverages hierarchical ray marching for efficient performance.

Tracing

Scenes can be traced against using Scene.Trace - which uses a builder pattern to make construction a bit easier. At a minimum, traces have a shape, start, and end. You can also filter which specific tags will be hit or ignored, or opt-in to using your project's collision rule matrix by calling WithCollisionRules(tag).

Physics

S&box includes a full 3D and 2D physics system powered by the Source 2 engine, with great performance and stability. Rigidbodies, colliders, joints, raycasting, and trigger volumes are all usable through Components on GameObjects.

Constructors

Showing 1 constructors

Methods

Showing 3 methods

public Vector3 Project(float distance)

Returns a point on the ray at given distance.

Parameters

  • distance: How far from the `Ray.Position` the point should be.

Returns

The point at given distance.

public Ray ToLocal(Transform tx)

Convert a ray to be local to this transform

public Ray ToWorld(Transform tx)

Convert a ray from being local to this transform

Properties

Showing 2 properties

public Vector3 Ray.Forward { get; set; }

Direction of the ray.

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.System
Doc IDT:Ray

RangeType

Previous Page

Rotation

Next Page

On this page

Constructorspublic Ray(Vector3 origin, Vector3 direction)Methodspublic Vector3 Project(System.Single distance)public Ray ToLocal(Transform tx)public Ray ToWorld(Transform tx)Propertiespublic Vector3 Ray.Forward { get; set; }public Vector3 Ray.Position { get; set; }Metadata