Outdated documentation

This documentation page refers to Godot 4.3, and may be outdated or incorrect.
Additionally, this engine version is no longer supported.

Check this page in the stable branch for the latest additions and corrections.

SeparationRayShape3D

Inherits: Shape3D < Resource < RefCounted < Object

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

Description

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.

Properties

float

length

1.0

bool

slide_on_slope

false

Property Descriptions

float length = 1.0 🔗

  • void set_length(value: float)

  • float get_length()

The ray's length.

bool slide_on_slope = false 🔗

  • void set_slide_on_slope(value: bool)

  • bool 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.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.