summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionPolygon3D.xml
diff options
context:
space:
mode:
authorRicardo Buring <ricardo.buring@gmail.com>2023-03-05 16:36:01 +0100
committerYuri Sizov <yuris@humnom.net>2023-03-27 17:10:03 +0200
commit68e623459592d557893eddd3fa570d0b7cdf21f2 (patch)
tree19bb3231e054f475cd95bf11ef9338427d57e272 /doc/classes/CollisionPolygon3D.xml
parent0dab32f317c4520ae2463f33d61381214a9c87c5 (diff)
Fix concave/convex polygon shape documentation
Removes some outdated/incorrect/duplicated info, adds correct info. Also removes no longer applicable "editor-only helper" statements. (cherry picked from commit e61a127042b183caa713a0eff852f26cdedbc2c0)
Diffstat (limited to 'doc/classes/CollisionPolygon3D.xml')
-rw-r--r--doc/classes/CollisionPolygon3D.xml10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml
index 29e55367a8..39f77bde39 100644
--- a/doc/classes/CollisionPolygon3D.xml
+++ b/doc/classes/CollisionPolygon3D.xml
@@ -1,18 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionPolygon3D" inherits="Node3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
- Editor-only node for defining a collision polygon in 3D space.
+ Node that represents a 3D collision polygon, given by the thickening of a 2D polygon in the local XY plane along the local Z axis.
</brief_description>
<description>
- Allows editing a concave or convex collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at run-time. Creates several [ConvexPolygonShape3D]s at run-time to represent the original polygon using convex decomposition.
- [b]Note:[/b] Since this is an editor-only helper, properties modified during gameplay will have no effect.
+ Provides a 3D collision polygon to a [CollisionObject3D] parent, by thickening a 2D (convex or concave) polygon in the local XY plane along the local Z axis. The 2D polygon in the local XY plane can be drawn in the editor or specified by a list of vertices. That 2D polygon is thickened evenly in the local Z and -Z directions.
+ This node has the same effect as several [ConvexPolygonShape3D] nodes, created by thickening the 2D convex polygons in the convex decomposition of the given 2D polygon (but without the overhead of multiple nodes).
[b]Warning:[/b] A non-uniformly scaled CollisionPolygon3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change its [member polygon]'s vertices instead.
</description>
<tutorials>
</tutorials>
<members>
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">
- Length that the resulting collision extends in either direction perpendicular to its polygon.
+ Length that the resulting collision extends in either direction perpendicular to its 2D polygon.
</member>
<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
If [code]true[/code], no collision will be produced.
@@ -21,7 +21,7 @@
The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.
</member>
<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">
- Array of vertices which define the polygon.
+ Array of vertices which define the 2D polygon in the local XY plane.
[b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member.
</member>
</members>