CollisionPolygon

Inherits: Spatial < Node < Object

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 = 1.0

  • void set_depth ( float value )

  • float get_depth ( )

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


bool disabled = false

  • void set_disabled ( bool value )

  • bool is_disabled ( )

If true, no collision will be produced.


float margin = 0.04

  • void set_margin ( float value )

  • float get_margin ( )

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


PoolVector2Array polygon = PoolVector2Array(  )

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.