Polygon2D

Inherits: Node2D < CanvasItem < Node < Object

A 2D polygon.

Description

A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.

Note: By default, Godot can only draw up to 4,096 polygon points at a time. To increase this limit, open the Project Settings and increase ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb and ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb.

Methods

voidadd_bone ( NodePath path, PoolRealArray weights )
voidclear_bones ( )
voiderase_bone ( int index )
intget_bone_count ( ) const
NodePathget_bone_path ( int index ) const
PoolRealArrayget_bone_weights ( int index ) const
voidset_bone_path ( int index, NodePath path )
voidset_bone_weights ( int index, PoolRealArray weights )

Property Descriptions

Defaultfalse
Setterset_antialiased(value)
Getterget_antialiased()

If true, polygon edges will be anti-aliased.


Default[  ]

DefaultColor( 1, 1, 1, 1 )
Setterset_color(value)
Getterget_color()

The polygon’s fill color. If texture is defined, it will be multiplied by this color. It will also be the default color for vertices not set in vertex_colors.


  • int internal_vertex_count
Default0
Setterset_internal_vertex_count(value)
Getterget_internal_vertex_count()

Default100.0
Setterset_invert_border(value)
Getterget_invert_border()

Added padding applied to the bounding box when using invert. Setting this value too small may result in a “Bad Polygon” error.


Defaultfalse
Setterset_invert(value)
Getterget_invert()

If true, polygon will be inverted, containing the area outside the defined points and extending to the invert_border.


DefaultVector2( 0, 0 )
Setterset_offset(value)
Getterget_offset()

The offset applied to each vertex.


DefaultPoolVector2Array(  )
Setterset_polygon(value)
Getterget_polygon()

The polygon’s list of vertices. The final point will be connected to the first.

Note: This returns a copy of the PoolVector2Array rather than a reference.


Default[  ]
Setterset_polygons(value)
Getterget_polygons()

DefaultNodePath("")
Setterset_skeleton(value)
Getterget_skeleton()

Setterset_texture(value)
Getterget_texture()

The polygon’s fill texture. Use uv to set texture coordinates.


DefaultVector2( 0, 0 )
Setterset_texture_offset(value)
Getterget_texture_offset()

Amount to offset the polygon’s texture. If (0, 0) the texture’s origin (its top-left corner) will be placed at the polygon’s position.


Setterset_texture_rotation(value)
Getterget_texture_rotation()

The texture’s rotation in radians.


  • float texture_rotation_degrees
Default0.0
Setterset_texture_rotation_degrees(value)
Getterget_texture_rotation_degrees()

The texture’s rotation in degrees.


DefaultVector2( 1, 1 )
Setterset_texture_scale(value)
Getterget_texture_scale()

Amount to multiply the uv coordinates when using a texture. Larger values make the texture smaller, and vice versa.


DefaultPoolVector2Array(  )
Setterset_uv(value)
Getterget_uv()

Texture coordinates for each vertex of the polygon. There should be one uv per polygon vertex. If there are fewer, undefined vertices will use (0, 0).


DefaultPoolColorArray(  )
Setterset_vertex_colors(value)
Getterget_vertex_colors()

Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use color.

Method Descriptions


  • void clear_bones ( )

  • void erase_bone ( int index )

  • int get_bone_count ( ) const




Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. 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.