diff options
author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-03-02 01:37:19 +0100 |
---|---|---|
committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-03-02 20:28:43 +0100 |
commit | a30e5805afc4d07ea7762463dbade4709867ee6b (patch) | |
tree | 04cd1d3cfb8377509a1367c2be40542aadf9d260 /doc/classes/CollisionPolygon3D.xml | |
parent | 62765fb7ca7cca7ae0c56be99cc99d9b3b0bd040 (diff) | |
download | redot-engine-a30e5805afc4d07ea7762463dbade4709867ee6b.tar.gz |
Improve documentation related to physics collision shapes
- Document using convex decomposition in the editor.
- Mention that "trimesh" is synonymous with a concave collision shape.
- Add performance hints for each collision shape.
Diffstat (limited to 'doc/classes/CollisionPolygon3D.xml')
-rw-r--r-- | doc/classes/CollisionPolygon3D.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/CollisionPolygon3D.xml b/doc/classes/CollisionPolygon3D.xml index c8c3752254..7d718cff27 100644 --- a/doc/classes/CollisionPolygon3D.xml +++ b/doc/classes/CollisionPolygon3D.xml @@ -1,10 +1,11 @@ <?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 class for defining a collision polygon in 3D space. + Editor-only node for defining a collision polygon in 3D space. </brief_description> <description> - Allows editing a 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 a [Shape3D] for gameplay. Properties modified during gameplay will have no effect. + 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. </description> <tutorials> </tutorials> |