CollisionPolygon

Refreshing Cache...

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

floatdepth1.0
booldisabledfalse
PoolVector2ArraypolygonPoolVector2Array(  )

Property Descriptions

Default1.0
Setterset_depth(value)
Getterget_depth()

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


Defaultfalse
Setterset_disabled(value)
Getteris_disabled()

If true, no collision will be produced.


DefaultPoolVector2Array(  )
Setterset_polygon(value)
Getterget_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.

doradoro's advice! Getters and Setters will be deprecated! Avoid their use!

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:30:25. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.