2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:40:43 +01:00
<class name= "Polygon2D" inherits= "Node2D" category= "Core" version= "3.1" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-10-02 06:13:36 +02:00
A 2D polygon.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-10-02 06:13:36 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
2018-05-12 09:38:00 +02:00
<method name= "add_bone" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "NodePath" >
</argument>
<argument index= "1" name= "weights" type= "PoolRealArray" >
</argument>
<description >
</description>
</method>
<method name= "clear_bones" >
<return type= "void" >
</return>
<description >
</description>
</method>
<method name= "erase_bone" >
<return type= "void" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_bone_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
</description>
</method>
<method name= "get_bone_path" qualifiers= "const" >
<return type= "NodePath" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_bone_weights" qualifiers= "const" >
<return type= "PoolRealArray" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "set_bone_path" >
<return type= "void" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<argument index= "1" name= "path" type= "NodePath" >
</argument>
<description >
</description>
</method>
<method name= "set_bone_weights" >
<return type= "void" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<argument index= "1" name= "weights" type= "PoolRealArray" >
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "antialiased" type= "bool" setter= "set_antialiased" getter= "get_antialiased" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], polygon edges will be anti-aliased. Default value: [code]false[/code].
2017-09-12 22:42:36 +02:00
</member>
2018-05-12 09:38:00 +02:00
<member name= "bones" type= "Array" setter= "_set_bones" getter= "_get_bones" >
</member>
2017-09-13 08:49:40 +02:00
<member name= "color" type= "Color" setter= "set_color" getter= "get_color" >
2017-10-02 06:13:36 +02:00
The polygon's fill color. If [code]texture[/code] is defined, it will be multiplied by this color. It will also be the default color for vertices not set in [code]vertex_colors[/code].
2017-09-12 22:42:36 +02:00
</member>
2019-01-10 14:34:15 +01:00
<member name= "internal_vertex_count" type= "int" setter= "set_internal_vertex_count" getter= "get_internal_vertex_count" >
</member>
2017-09-13 08:49:40 +02:00
<member name= "invert_border" type= "float" setter= "set_invert_border" getter= "get_invert_border" >
2017-10-02 06:13:36 +02:00
Added padding applied to the bounding box when using [code]invert[/code]. Setting this value too small may result in a "Bad Polygon" error. Default value: [code]100[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "invert_enable" type= "bool" setter= "set_invert" getter= "get_invert" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], polygon will be inverted, containing the area outside the defined points and extending to the [code]invert_border[/code]. Default value: [code]false[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "offset" type= "Vector2" setter= "set_offset" getter= "get_offset" >
2017-10-02 06:13:36 +02:00
The offset applied to each vertex.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "polygon" type= "PoolVector2Array" setter= "set_polygon" getter= "get_polygon" >
2019-02-20 05:03:40 +01:00
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.
2017-09-12 22:42:36 +02:00
</member>
2019-01-10 14:34:15 +01:00
<member name= "polygons" type= "Array" setter= "set_polygons" getter= "get_polygons" >
2018-05-12 09:38:00 +02:00
</member>
2019-01-10 14:34:15 +01:00
<member name= "skeleton" type= "NodePath" setter= "set_skeleton" getter= "get_skeleton" >
2018-02-27 13:41:27 +01:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-10-02 06:13:36 +02:00
The polygon's fill texture. Use [code]uv[/code] to set texture coordinates.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "texture_offset" type= "Vector2" setter= "set_texture_offset" getter= "get_texture_offset" >
2017-10-02 06:13:36 +02:00
Amount to offset the polygon's [code]texture[/code]. If [code](0, 0)[/code] the texture's origin (its top-left corner) will be placed at the polygon's [code]position[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-11-10 11:07:52 +01:00
<member name= "texture_rotation" type= "float" setter= "set_texture_rotation_degrees" getter= "get_texture_rotation_degrees" >
2018-01-11 23:38:35 +01:00
The texture's rotation in radians.
</member>
<member name= "texture_rotation_degrees" type= "float" setter= "set_texture_rotation_degrees" getter= "get_texture_rotation_degrees" >
2017-10-02 06:13:36 +02:00
The texture's rotation in degrees.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "texture_scale" type= "Vector2" setter= "set_texture_scale" getter= "get_texture_scale" >
2017-10-02 06:13:36 +02:00
Amount to multiply the [code]uv[/code] coordinates when using a [code]texture[/code]. Larger values make the texture smaller, and vice versa.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "uv" type= "PoolVector2Array" setter= "set_uv" getter= "get_uv" >
2017-10-02 06:13:36 +02:00
Texture coordinates for each vertex of the polygon. There should be one [code]uv[/code] per polygon vertex. If there are fewer, undefined vertices will use [code](0, 0)[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "vertex_colors" type= "PoolColorArray" setter= "set_vertex_colors" getter= "get_vertex_colors" >
2017-10-02 06:13:36 +02:00
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 [code]color[/code].
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>