Inherits: Node2D < CanvasItem < Node < Object

Category: Core

Brief Description

Defines a 2D collision polygon.

Member Variables

  • BuildMode build_mode - Collision build mode. Use one of the BUILD_* constants. Default value: BUILD_SOLIDS.
  • bool disabled - If true no collisions will be detected.
  • bool one_way_collision - If true only edges that face up, relative to CollisionPolygon2D’s rotation, will collide with other objects.
  • PoolVector2Array polygon - The polygon’s list of vertices. The final point will be connected to the first.


enum BuildMode

  • BUILD_SOLIDS = 0 — Collisions will include the polygon and its contained area.
  • BUILD_SEGMENTS = 1 — Collisions will only include the polygon edges.


Provides a 2D collision polygon to a CollisionObject2D parent. Polygon can be drawn in the editor or specified by a list of vertices.