Inherits: Spatial < Node < Object

Category: Core

Brief Description

Editor-only class for defining a collision polygon in 3D space.


Allows editing a collision polygon’s vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a Shape for gameplay. Properties modified during gameplay will have no effect.

Property Descriptions

Setter set_depth(value)
Getter get_depth()

Length that the resulting collision extends in either direction perpendicular to its polygon.

Setter set_disabled(value)
Getter is_disabled()

If true, no collision will be produced.

Setter set_polygon(value)
Getter get_polygon()

Array of vertices which define the polygon. Note that the returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the polygon member.