Class Polygon2D

A 2D polygon.

Inheritance

Node2D

CanvasItem

Node

Object

Polygon2D

Remarks

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

antialiased

If true, polygon edges will be anti-aliased.

var antialiased : bool = false

Property Value

bool

Remarks

• void set_antialiased(bool value)
• bool get_antialiased

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.

var color : Color = Color(1, 1, 1, 1)

Property Value

Color

Remarks

• void set_color(Color value)
• Color get_color

internal_vertex_count

Number of internal vertices, used for UV mapping.

var internal_vertex_count : int = 0

Property Value

int

Remarks

• void set_internal_vertex_count(int value)
• int get_internal_vertex_count

invert_border

Added padding applied to the bounding box when invert_enabled is set to true. Setting this value too small may result in a "Bad Polygon" error.

var invert_border : float = 100.0

Property Value

float

Remarks

• void set_invert_border(float value)
• float get_invert_border

invert_enabled

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

var invert_enabled : bool = false

Property Value

bool

Remarks

• void set_invert_enabled(bool value)
• bool get_invert_enabled

offset

The offset applied to each vertex.

var offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_offset(Vector2 value)
• Vector2 get_offset

polygon

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

var polygon : PackedVector2Array = PackedVector2Array()

Property Value

PackedVector2Array

Remarks

• void set_polygon(PackedVector2Array value)
• PackedVector2Array get_polygon

polygons

The list of polygons, in case more than one is being represented. Every individual polygon is stored as a PackedInt32Array where each int is an index to a point in polygon. If empty, this property will be ignored, and the resulting single polygon will be composed of all points in polygon, using the order they are stored in.

var polygons : Array = []

Property Value

Array

Remarks

• void set_polygons(Array value)
• Array get_polygons

skeleton

Path to a Skeleton2D node used for skeleton-based deformations of this polygon. If empty or invalid, skeletal deformations will not be used.

var skeleton : NodePath = NodePath("")

Property Value

NodePath

Remarks

• void set_skeleton(NodePath value)
• NodePath get_skeleton

texture

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

var texture : Texture2D

Property Value

Texture2D

Remarks

• void set_texture(Texture2D value)
• Texture2D get_texture

texture_offset

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

var texture_offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_texture_offset(Vector2 value)
• Vector2 get_texture_offset

texture_rotation

The texture's rotation in radians.

var texture_rotation : float = 0.0

Property Value

float

Remarks

• void set_texture_rotation(float value)
• float get_texture_rotation

texture_scale

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

var texture_scale : Vector2 = Vector2(1, 1)

Property Value

Vector2

Remarks

• void set_texture_scale(Vector2 value)
• Vector2 get_texture_scale

uv

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

var uv : PackedVector2Array = PackedVector2Array()

Property Value

PackedVector2Array

Remarks

• void set_uv(PackedVector2Array value)
• PackedVector2Array get_uv

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.

var vertex_colors : PackedColorArray = PackedColorArray()

Property Value

PackedColorArray

Remarks

• void set_vertex_colors(PackedColorArray value)
• PackedColorArray get_vertex_colors

Methods

add_bone(NodePath, PackedFloat32Array)

Adds a bone with the specified path and weights.

void add_bone(NodePath path, PackedFloat32Array weights)

Parameters

path NodePath

weights PackedFloat32Array

clear_bones

Removes all bones from this Polygon2D.

void clear_bones

erase_bone(int)

Removes the specified bone from this Polygon2D.

void erase_bone(int index)

Parameters

index int

get_bone_count

Qualifiers: const

Returns the number of bones in this Polygon2D.

int get_bone_count

get_bone_path(int)

Qualifiers: const

Returns the path to the node associated with the specified bone.

NodePath get_bone_path(int index)

Parameters

index int

get_bone_weights(int)

Qualifiers: const

Returns the weight values of the specified bone.

PackedFloat32Array get_bone_weights(int index)

Parameters

index int

set_bone_path(int, NodePath)

Sets the path to the node associated with the specified bone.

void set_bone_path(int index, NodePath path)

Parameters

index int

path NodePath

set_bone_weights(int, PackedFloat32Array)

Sets the weight values for the specified bone.

void set_bone_weights(int index, PackedFloat32Array weights)

Parameters

index int

weights PackedFloat32Array