:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/Polygon2D.xml. .. _class_Polygon2D: Polygon2D ========= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A 2D polygon. .. rst-class:: classref-introduction-group 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 :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_buffer_size_kb` and :ref:`ProjectSettings.rendering/limits/buffers/canvas_polygon_index_buffer_size_kb`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`antialiased` | ``false`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Array` | :ref:`bones` | ``[ ]`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Color` | :ref:`color` | ``Color( 1, 1, 1, 1 )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`int` | :ref:`internal_vertex_count` | ``0`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`float` | :ref:`invert_border` | ``100.0`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`bool` | :ref:`invert_enable` | ``false`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`PoolVector2Array` | :ref:`polygon` | ``PoolVector2Array( )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Array` | :ref:`polygons` | ``[ ]`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`NodePath` | :ref:`skeleton` | ``NodePath("")`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Texture` | :ref:`texture` | | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2` | :ref:`texture_offset` | ``Vector2( 0, 0 )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`float` | :ref:`texture_rotation` | | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`float` | :ref:`texture_rotation_degrees` | ``0.0`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`Vector2` | :ref:`texture_scale` | ``Vector2( 1, 1 )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`PoolVector2Array` | :ref:`uv` | ``PoolVector2Array( )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ | :ref:`PoolColorArray` | :ref:`vertex_colors` | ``PoolColorArray( )`` | +-------------------------------------------------+------------------------------------------------------------------------------------+--------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_bone` **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_bones` **(** **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_bone` **(** :ref:`int` index **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_bone_count` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_bone_path` **(** :ref:`int` index **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolRealArray` | :ref:`get_bone_weights` **(** :ref:`int` index **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_path` **(** :ref:`int` index, :ref:`NodePath` path **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bone_weights` **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Polygon2D_property_antialiased: .. rst-class:: classref-property :ref:`bool` **antialiased** = ``false`` .. rst-class:: classref-property-setget - void **set_antialiased** **(** :ref:`bool` value **)** - :ref:`bool` **get_antialiased** **(** **)** If ``true``, attempts to perform antialiasing for polygon edges by drawing a thin OpenGL smooth line on the edges. \ **Note:** Due to how it works, built-in antialiasing will not look correct for translucent polygons and may not work on certain platforms. As a workaround, install the `Antialiased Line2D `__ add-on then create an AntialiasedPolygon2D node. That node relies on a texture with custom mipmaps to perform antialiasing. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_bones: .. rst-class:: classref-property :ref:`Array` **bones** = ``[ ]`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color( 1, 1, 1, 1 )`` .. rst-class:: classref-property-setget - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_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``. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_internal_vertex_count: .. rst-class:: classref-property :ref:`int` **internal_vertex_count** = ``0`` .. rst-class:: classref-property-setget - void **set_internal_vertex_count** **(** :ref:`int` value **)** - :ref:`int` **get_internal_vertex_count** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_invert_border: .. rst-class:: classref-property :ref:`float` **invert_border** = ``100.0`` .. rst-class:: classref-property-setget - void **set_invert_border** **(** :ref:`float` value **)** - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_invert_enable: .. rst-class:: classref-property :ref:`bool` **invert_enable** = ``false`` .. rst-class:: classref-property-setget - void **set_invert** **(** :ref:`bool` value **)** - :ref:`bool` **get_invert** **(** **)** If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_offset** **(** **)** The offset applied to each vertex. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_polygon: .. rst-class:: classref-property :ref:`PoolVector2Array` **polygon** = ``PoolVector2Array( )`` .. rst-class:: classref-property-setget - void **set_polygon** **(** :ref:`PoolVector2Array` value **)** - :ref:`PoolVector2Array` **get_polygon** **(** **)** The polygon's list of vertices. The final point will be connected to the first. \ **Note:** This returns a copy of the :ref:`PoolVector2Array` rather than a reference. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_polygons: .. rst-class:: classref-property :ref:`Array` **polygons** = ``[ ]`` .. rst-class:: classref-property-setget - void **set_polygons** **(** :ref:`Array` value **)** - :ref:`Array` **get_polygons** **(** **)** The list of polygons, in case more than one is being represented. Every individual polygon is stored as a :ref:`PoolIntArray` where each :ref:`int` is an index to a point in :ref:`polygon`. If empty, this property will be ignored, and the resulting single polygon will be composed of all points in :ref:`polygon`, using the order they are stored in. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_skeleton: .. rst-class:: classref-property :ref:`NodePath` **skeleton** = ``NodePath("")`` .. rst-class:: classref-property-setget - void **set_skeleton** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_skeleton** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_texture: .. rst-class:: classref-property :ref:`Texture` **texture** .. rst-class:: classref-property-setget - void **set_texture** **(** :ref:`Texture` value **)** - :ref:`Texture` **get_texture** **(** **)** The polygon's fill texture. Use ``uv`` to set texture coordinates. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_texture_offset: .. rst-class:: classref-property :ref:`Vector2` **texture_offset** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_texture_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_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``. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_texture_rotation: .. rst-class:: classref-property :ref:`float` **texture_rotation** .. rst-class:: classref-property-setget - void **set_texture_rotation** **(** :ref:`float` value **)** - :ref:`float` **get_texture_rotation** **(** **)** The texture's rotation in radians. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_texture_rotation_degrees: .. rst-class:: classref-property :ref:`float` **texture_rotation_degrees** = ``0.0`` .. rst-class:: classref-property-setget - void **set_texture_rotation_degrees** **(** :ref:`float` value **)** - :ref:`float` **get_texture_rotation_degrees** **(** **)** The texture's rotation in degrees. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_texture_scale: .. rst-class:: classref-property :ref:`Vector2` **texture_scale** = ``Vector2( 1, 1 )`` .. rst-class:: classref-property-setget - void **set_texture_scale** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_texture_scale** **(** **)** Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_uv: .. rst-class:: classref-property :ref:`PoolVector2Array` **uv** = ``PoolVector2Array( )`` .. rst-class:: classref-property-setget - void **set_uv** **(** :ref:`PoolVector2Array` value **)** - :ref:`PoolVector2Array` **get_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)``. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_property_vertex_colors: .. rst-class:: classref-property :ref:`PoolColorArray` **vertex_colors** = ``PoolColorArray( )`` .. rst-class:: classref-property-setget - void **set_vertex_colors** **(** :ref:`PoolColorArray` value **)** - :ref:`PoolColorArray` **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``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Polygon2D_method_add_bone: .. rst-class:: classref-method void **add_bone** **(** :ref:`NodePath` path, :ref:`PoolRealArray` weights **)** Adds a bone with the specified ``path`` and ``weights``. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_clear_bones: .. rst-class:: classref-method void **clear_bones** **(** **)** Removes all bones from this **Polygon2D**. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_erase_bone: .. rst-class:: classref-method void **erase_bone** **(** :ref:`int` index **)** Removes the specified bone from this **Polygon2D**. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_get_bone_count: .. rst-class:: classref-method :ref:`int` **get_bone_count** **(** **)** |const| Returns the number of bones in this **Polygon2D**. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_get_bone_path: .. rst-class:: classref-method :ref:`NodePath` **get_bone_path** **(** :ref:`int` index **)** |const| Returns the path to the node associated with the specified bone. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_get_bone_weights: .. rst-class:: classref-method :ref:`PoolRealArray` **get_bone_weights** **(** :ref:`int` index **)** |const| Returns the height values of the specified bone. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_set_bone_path: .. rst-class:: classref-method void **set_bone_path** **(** :ref:`int` index, :ref:`NodePath` path **)** Sets the path to the node associated with the specified bone. .. rst-class:: classref-item-separator ---- .. _class_Polygon2D_method_set_bone_weights: .. rst-class:: classref-method void **set_bone_weights** **(** :ref:`int` index, :ref:`PoolRealArray` weights **)** Sets the weight values for the specified bone. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`