WorldBoundaryShape2D

Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

WorldBoundaryShape2D

Inherits: Shape2D < Resource < RefCounted < Object

A 2D world boundary (half-plane) shape used for physics collision.

Description

A 2D world boundary shape, intended for use in physics. WorldBoundaryShape2D works like an infinite straight line that forces all physics bodies to stay above it. The line’s normal determines which direction is considered as “above” and in the editor, the smaller line over it represents this direction. It can for example be used for endless flat floors.

Properties

float	distance	`0.0`
Vector2	normal	`Vector2(0, -1)`

Property Descriptions

float distance = 0.0

void set_distance ( float value )
float get_distance ( )

The distance from the origin to the line, expressed in terms of normal (according to its direction and magnitude). Actual absolute distance from the origin to the line can be calculated as abs(distance) / normal.length().

In the scalar equation of the line ax + by = d, this is d, while the (a, b) coordinates are represented by the normal property.

Vector2 normal = Vector2(0, -1)

void set_normal ( Vector2 value )
Vector2 get_normal ( )

The line’s normal, typically a unit vector. Its direction indicates the non-colliding half-plane. Can be of any length but zero. Defaults to Vector2.UP.