2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "Polygon2D" inherits= "Node2D" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-10-02 12:13:36 +08:00
A 2D polygon.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2018-05-12 15:38:00 +08:00
<method name= "add_bone" >
<return type= "void" >
</return>
<argument index= "0" name= "path" type= "NodePath" >
</argument>
2020-02-26 01:10:58 +08:00
<argument index= "1" name= "weights" type= "PackedFloat32Array" >
2018-05-12 15:38:00 +08:00
</argument>
<description >
2020-03-04 02:21:21 +08:00
Adds a bone with the specified [code]path[/code] and [code]weights[/code].
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "clear_bones" >
<return type= "void" >
</return>
<description >
2020-03-04 02:21:21 +08:00
Removes all bones from this [Polygon2D].
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "erase_bone" >
<return type= "void" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
2020-03-04 02:21:21 +08:00
Removes the specified bone from this [Polygon2D].
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "get_bone_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-03-04 02:21:21 +08:00
Returns the number of bones in this [Polygon2D].
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "get_bone_path" qualifiers= "const" >
<return type= "NodePath" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
2020-03-04 02:21:21 +08:00
Returns the path to the node associated with the specified bone.
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "get_bone_weights" qualifiers= "const" >
2020-02-26 01:10:58 +08:00
<return type= "PackedFloat32Array" >
2018-05-12 15:38:00 +08:00
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
2020-03-04 02:21:21 +08:00
Returns the height values of the specified bone.
2018-05-12 15:38:00 +08:00
</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 >
2020-03-04 02:21:21 +08:00
Sets the path to the node associated with the specified bone.
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name= "set_bone_weights" >
<return type= "void" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
2020-02-26 01:10:58 +08:00
<argument index= "1" name= "weights" type= "PackedFloat32Array" >
2018-05-12 15:38:00 +08:00
</argument>
<description >
2020-03-04 02:21:21 +08:00
Sets the weight values for the specified bone.
2018-05-12 15:38:00 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "antialiased" type= "bool" setter= "set_antialiased" getter= "get_antialiased" default= "false" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], polygon edges will be anti-aliased.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "bones" type= "Array" setter= "_set_bones" getter= "_get_bones" default= "[]" >
2018-05-12 15:38:00 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "color" type= "Color" setter= "set_color" getter= "get_color" default= "Color(1, 1, 1, 1)" >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "internal_vertex_count" type= "int" setter= "set_internal_vertex_count" getter= "get_internal_vertex_count" default= "0" >
2019-01-10 21:34:15 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "invert_border" type= "float" setter= "set_invert_border" getter= "get_invert_border" default= "100.0" >
2019-06-29 21:24:23 +08: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.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "invert_enable" type= "bool" setter= "set_invert" getter= "get_invert" default= "false" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], polygon will be inverted, containing the area outside the defined points and extending to the [code]invert_border[/code].
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "offset" type= "Vector2" setter= "set_offset" getter= "get_offset" default= "Vector2(0, 0)" >
2017-10-02 12:13:36 +08:00
The offset applied to each vertex.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "polygon" type= "PackedVector2Array" setter= "set_polygon" getter= "get_polygon" default= "PackedVector2Array()" >
2019-06-22 07:04:47 +08:00
The polygon's list of vertices. The final point will be connected to the first.
2020-02-18 20:59:24 +08:00
[b]Note:[/b] This returns a copy of the [PackedVector2Array] rather than a reference.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "polygons" type= "Array" setter= "set_polygons" getter= "get_polygons" default= "[]" >
2018-05-12 15:38:00 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "skeleton" type= "NodePath" setter= "set_skeleton" getter= "get_skeleton" default= "NodePath("")" >
2018-02-27 20:41:27 +08:00
</member>
2020-02-12 16:59:06 +08:00
<member name= "texture" type= "Texture2D" setter= "set_texture" getter= "get_texture" >
2017-10-02 12:13:36 +08:00
The polygon's fill texture. Use [code]uv[/code] to set texture coordinates.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "texture_offset" type= "Vector2" setter= "set_texture_offset" getter= "get_texture_offset" default= "Vector2(0, 0)" >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</member>
Fix editor suffixes and degrees conversion
* Functions to convert to/from degrees are all gone. Conversion is done by the editor.
* Use PROPERTY_HINT_ANGLE instead of PROPERTY_HINT_RANGE to edit radian angles in degrees.
* Added possibility to add suffixes to range properties, use "min,max[,step][,suffix:<something>]" example "0,100,1,suffix:m"
* In general, can add suffixes for EditorSpinSlider
Not covered by this PR, will have to be addressed by future ones:
* Ability to switch radians/degrees in the inspector for angle properties (if actually wanted).
* Animations previously made will most likely break, need to add a way to make old ones compatible.
* Only added a "px" suffix to 2D position and a "m" one to 3D position, someone needs to go through the rest of the engine and add all remaining suffixes.
* Likely also need to track down usage of EditorSpinSlider outside properties to add suffixes to it too.
2021-06-30 03:42:12 +08:00
<member name= "texture_rotation" type= "float" setter= "set_texture_rotation" getter= "get_texture_rotation" default= "0.0" >
2018-01-12 06:38:35 +08:00
The texture's rotation in radians.
</member>
2019-09-25 01:45:03 +08:00
<member name= "texture_scale" type= "Vector2" setter= "set_texture_scale" getter= "get_texture_scale" default= "Vector2(1, 1)" >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "uv" type= "PackedVector2Array" setter= "set_uv" getter= "get_uv" default= "PackedVector2Array()" >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "vertex_colors" type= "PackedColorArray" setter= "set_vertex_colors" getter= "get_vertex_colors" default= "PackedColorArray()" >
2017-10-02 12:13:36 +08: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-13 04:42:36 +08:00
</member>
</members>
<constants >
</constants>
</class>
