Class CollisionPolygon3D

A node that provides a thickened polygon shape (a prism) to a CollisionObject3D parent.

Inheritance

Node3D

Node

Object

CollisionPolygon3D

Remarks

A node that provides a thickened polygon shape (a prism) to a CollisionObject3D parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an Area3D or turn PhysicsBody3D into a solid object.

Warning: A non-uniformly scaled CollisionShape3D will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead.

Properties

debug_color

The collision shape color that is displayed in the editor, or in the running project if Debug > Visible Collision Shapes is checked at the top of the editor.

Note: The default value is debug/shapes/collision/shape_color. The Color(0, 0, 0, 0) value documented here is a placeholder, and not the actual default debug color.

var debug_color : Color = Color(0, 0, 0, 0)

Property Value

Color

Remarks

• void set_debug_color(Color value)
• Color get_debug_color

debug_fill

If true, when the shape is displayed, it will show a solid fill color in addition to its wireframe.

var debug_fill : bool = true

Property Value

bool

Remarks

• void set_enable_debug_fill(bool value)
• bool get_enable_debug_fill

depth

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

var depth : float = 1.0

Property Value

float

Remarks

• void set_depth(float value)
• float get_depth

disabled

If true, no collision will be produced.

var disabled : bool = false

Property Value

bool

Remarks

• void set_disabled(bool value)
• bool is_disabled

margin

The collision margin for the generated Shape3D. See margin for more details.

var margin : float = 0.04

Property Value

float

Remarks

• void set_margin(float value)
• float get_margin

polygon

Array of vertices which define the 2D polygon in the local XY plane.

var polygon : PackedVector2Array = PackedVector2Array()

Property Value

PackedVector2Array

Remarks

• void set_polygon(PackedVector2Array value)
• PackedVector2Array get_polygon