CollisionPolygon

CollisionPolygon

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

Description

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 run-time. Creates a Shape for gameplay. Properties modified during gameplay will have no effect.

Properties

float	depth	`1.0`
bool	disabled	`false`
float	margin	`0.04`
PoolVector2Array	polygon	`PoolVector2Array( )`

Property Descriptions

float depth

Default	`1.0`
Setter	set_depth(value)
Getter	get_depth()

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

bool disabled

Default	`false`
Setter	set_disabled(value)
Getter	is_disabled()

If true, no collision will be produced.

float margin

Default	`0.04`
Setter	set_margin(value)
Getter	get_margin()

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

PoolVector2Array polygon

Default	`PoolVector2Array( )`
Setter	set_polygon(value)
Getter	get_polygon()

Array of vertices which define the polygon.

Note: 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.