diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml index d3dee1e9bbb..7f30e8e83e8 100644 --- a/doc/classes/CollisionPolygon2D.xml +++ b/doc/classes/CollisionPolygon2D.xml @@ -1,10 +1,10 @@ - Editor-only class for defining a collision polygon in 2D space. + Defines a 2D collision polygon. - Allows editing a collision polygon's vertices. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape2D] for gameplay. Properties modified during gameplay will have no effect. + Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygon can be drawn in the editor or specified by a list of vertices. @@ -75,22 +75,24 @@ - If BUILD_SOLIDS, the polygon and the area within it will have collision. If BUILD_SEGMENTS, only the edges of the polygon will have collision. + Collision build mode. Use one of the [code]BUILD_*[/code] constants. Default value: [code]BUILD_SOLIDS[/code]. - If true, no collision will be produced. + If [code]true[/code] no collisions will be detected. - If true, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. + If [code]true[/code] only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. - Array of vertices which define the polygon. + The polygon's list of vertices. The final point will be connected to the first. + Collisions will include the polygon and its contained area. + Collisions will only include the polygon edges. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 05869c514eb..23cb9bd91ba 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -1,10 +1,10 @@ - 2D polygon representation + A 2D polygon. - A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon. + 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. @@ -204,28 +204,40 @@ + If [code]true[/code] polygon edges will be anti-aliased. Default value: [code]false[/code]. + 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]. + 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]. + 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]. + The offset applied to each vertex. + The polygon's list of vertices. The final point will be connected to the first. + The polygon's fill texture. Use [code]uv[/code] to set texture coordinates. + 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]. + The texture's rotation in degrees. + Amount to multiply the [code]uv[/code] coordinates when using a [code]texture[/code]. Larger values make the texture smaller, and vice versa. + 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]. + 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].