Polygon2D

Category: Core

A 2D polygon.

Properties

void	( NodePath path, weights )
void	clear_bones ( )
void	( int index )
	get_bone_count ( ) const
	get_bone_path ( index ) const
PoolRealArray	( int index ) const
void	( int index, path )
void	set_bone_weights ( index, PoolRealArray weights )

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.

antialiased

Setter	set_antialiased(value)
Getter	get_antialiased()

If , polygon edges will be anti-aliased. Default value: false.

Array bones

color

Setter	set_color(value)
Getter	get_color()

Setter	set_internal_vertex_count(value)
Getter	get_internal_vertex_count()

float invert_border

Setter	set_invert_border(value)
Getter	get_invert_border()

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

invert_enable

If , polygon will be inverted, containing the area outside the defined points and extending to the invert_border. Default value: false.

Vector2 offset

Setter	set_offset(value)
Getter	get_offset()

The offset applied to each vertex.

polygon

Setter	set_polygon(value)
Getter	get_polygon()

The polygon’s list of vertices. The final point will be connected to the first. Note that this returns a copy of the PoolVector2Array rather than a reference.

polygons

Setter	set_polygons(value)
Getter	get_polygons()

NodePath skeleton

Setter	set_skeleton(value)
Getter	get_skeleton()

texture

Setter	set_texture(value)
Getter	get_texture()

Vector2 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 .

texture_rotation

Setter	set_texture_rotation(value)
Getter	get_texture_rotation()

The texture’s rotation in radians.

Setter	set_texture_rotation_degrees(value)
Getter	get_texture_rotation_degrees()

The texture’s rotation in degrees.

Vector2 texture_scale

Setter	set_texture_scale(value)
Getter	get_texture_scale()

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

Setter	set_uv(value)
Getter	get_uv()

PoolColorArray vertex_colors

Setter	set_vertex_colors(value)
Getter	get_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 add_bone ( path, PoolRealArray weights )

void clear_bones ( )

void erase_bone ( index )

int get_bone_count ( ) const

get_bone_path ( int index ) const

get_bone_weights ( int index ) const

void set_bone_weights ( index, PoolRealArray weights )