Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

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.

Properties¶

bool	antialiased	`false`
Array	bones	`[]`
Color	color	`Color(1, 1, 1, 1)`
int	internal_vertex_count	`0`
float	invert_border	`100.0`
bool	invert_enabled	`false`
Vector2	offset	`Vector2(0, 0)`
PackedVector2Array	polygon	`PackedVector2Array()`
Array	polygons	`[]`
NodePath	skeleton	`NodePath("")`
Texture2D	texture
Vector2	texture_offset	`Vector2(0, 0)`
float	texture_rotation	`0.0`
Vector2	texture_scale	`Vector2(1, 1)`
PackedVector2Array	uv	`PackedVector2Array()`
PackedColorArray	vertex_colors	`PackedColorArray()`

Methods¶

void	add_bone ( NodePath path, PackedFloat32Array weights )
void	clear_bones ( )
void	erase_bone ( int index )
int	get_bone_count ( ) const
NodePath	get_bone_path ( int index ) const
PackedFloat32Array	get_bone_weights ( int index ) const
void	set_bone_path ( int index, NodePath path )
void	set_bone_weights ( int index, PackedFloat32Array weights )

Property Descriptions¶

bool antialiased = false

void set_antialiased ( bool value )
bool get_antialiased ( )

If true, polygon edges will be anti-aliased.

Array bones = []

Internal list of Bone2D nodes used by the assigned skeleton. Edited using the Polygon2D editor ("UV" button on the top toolbar).

Color color = Color(1, 1, 1, 1)

void set_color ( Color value )
Color get_color ( )

The polygon's fill color. If texture is set, 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 = 0