mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
8899f1eec2
godot/doc/classes/Polygon2D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

118 lines
5.9 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="Polygon2D" inherits="Node2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
[DOCS] Update Polygon2D and CollisionPolygon2D
2017-10-02 12:13:36 +08:00
A 2D polygon.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</brief_description>
<description>
[DOCS] Update Polygon2D and CollisionPolygon2D
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
<methods>
Sync classref with current source
2018-05-12 15:38:00 +08:00
<method name="add_bone">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="path" type="NodePath" />
<param index="1" name="weights" type="PackedFloat32Array" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-12 01:52:19 +08:00
Adds a bone with the specified [param path] and [param weights].
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="clear_bones">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Removes all bones from this [Polygon2D].
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="erase_bone">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="index" type="int" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Removes the specified bone from this [Polygon2D].
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="get_bone_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Returns the number of bones in this [Polygon2D].
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="get_bone_path" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="NodePath" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="index" type="int" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Returns the path to the node associated with the specified bone.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="get_bone_weights" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="PackedFloat32Array" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="index" type="int" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Returns the height values of the specified bone.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="set_bone_path">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="index" type="int" />
<param index="1" name="path" type="NodePath" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Sets the path to the node associated with the specified bone.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
<method name="set_bone_weights">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="index" type="int" />
<param index="1" name="weights" type="PackedFloat32Array" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
Sets the weight values for the specified bone.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], polygon edges will be anti-aliased.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="bones" type="Array" setter="_set_bones" getter="_get_bones" default="[]">
Sync classref with current source
2018-05-12 15:38:00 +08:00
</member>
Better format arguments in variant parser
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)">
[DOCS] Update Polygon2D and CollisionPolygon2D
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
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">
doc: Sync classref with current source + AUTHORS edit
2019-01-10 21:34:15 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
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">
Rename Polygon2D.`invert_enable` to end with "d" Polygon2D.`invert_enable` -> `invert_enabled` Also affects the setters and getters, which are now named in full instead of cutting "enabled" off. Updates old leftover documentation slightly, as well.
2022-08-24 18:50:44 +08:00
Added padding applied to the bounding box when [member invert_enabled] is set to [code]true[/code]. Setting this value too small may result in a "Bad Polygon" error.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Rename Polygon2D.`invert_enable` to end with "d" Polygon2D.`invert_enable` -> `invert_enabled` Also affects the setters and getters, which are now named in full instead of cutting "enabled" off. Updates old leftover documentation slightly, as well.
2022-08-24 18:50:44 +08:00
<member name="invert_enabled" type="bool" setter="set_invert_enabled" getter="get_invert_enabled" default="false">
If [code]true[/code], the polygon will be inverted, containing the area outside the defined points and extending to the [member invert_border].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2(0, 0)">
[DOCS] Update Polygon2D and CollisionPolygon2D
2017-10-02 12:13:36 +08:00
The offset applied to each vertex.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
The polygon's list of vertices. The final point will be connected to the first.
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
[b]Note:[/b] This returns a copy of the [PackedVector2Array] rather than a reference.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="polygons" type="Array" setter="set_polygons" getter="get_polygons" default="[]">
Sync classref with current source
2018-05-12 15:38:00 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="skeleton" type="NodePath" setter="set_skeleton" getter="get_skeleton" default="NodePath(&quot;&quot;)">
doc: Sync classref with current source
2018-02-27 20:41:27 +08:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
[DOCS] Update Polygon2D and CollisionPolygon2D
2017-10-02 12:13:36 +08:00
The polygon's fill texture. Use [code]uv[/code] to set texture coordinates.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
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)">
[DOCS] Update Polygon2D and CollisionPolygon2D
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
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">
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
The texture's rotation in radians.
</member>
Better format arguments in variant parser
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)">
[DOCS] Update Polygon2D and CollisionPolygon2D
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="uv" type="PackedVector2Array" setter="set_uv" getter="get_uv" default="PackedVector2Array()">
[DOCS] Update Polygon2D and CollisionPolygon2D
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="vertex_colors" type="PackedColorArray" setter="set_vertex_colors" getter="get_vertex_colors" default="PackedColorArray()">
[DOCS] Update Polygon2D and CollisionPolygon2D
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
</members>
</class>
Reference in New Issue Copy Permalink