Skip to content
Download
API reference

SeparationRayShape3D

Inherits: Shape3D < Resource < Shared < Object

A 3D ray shape used for physics collision that tries to separate itself from any collider.

A 3D ray shape, intended for use in physics. Usually used to provide a shape for a CollisionShape3D. When a SeparationRayShape3D collides with an object, it tries to separate itself from it by moving its endpoint to the collision point. For example, a SeparationRayShape3D next to a character can allow it to instantly move up when touching stairs.

TypeNameDefault
floatlength1.0
boolslide_on_slopefalse

float length = 1.0

Setter/getter: set_length(), get_length()

The ray’s length.

bool slide_on_slope = false

Setter/getter: set_slide_on_slope(), get_slide_on_slope()

If false (default), the shape always separates and returns a normal along its own direction.

If true, the shape can return the correct normal and separate in any direction, allowing sliding motion on slopes.