summaryrefslogtreecommitdiff
path: root/modules/csg/doc_classes/CSGPolygon3D.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-02-07 18:27:58 +0100
committerGitHub <noreply@github.com>2022-02-07 18:27:58 +0100
commit05bad19a9ab6b173c5e3287283eaa8f72c0c16d2 (patch)
treefeb26fcb671644147a590cc8bdfda7c73c789d4f /modules/csg/doc_classes/CSGPolygon3D.xml
parent650e218b9606e4640ac10ecbff1b7f08b6be0daf (diff)
parent5268786ac0213d4881f8a214b4d81f0c33340802 (diff)
Merge pull request #57752 from Calinou/doc-csg-nodes-performance
Diffstat (limited to 'modules/csg/doc_classes/CSGPolygon3D.xml')
-rw-r--r--modules/csg/doc_classes/CSGPolygon3D.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/modules/csg/doc_classes/CSGPolygon3D.xml b/modules/csg/doc_classes/CSGPolygon3D.xml
index 5a49eebc7b..e8ef79a9e5 100644
--- a/modules/csg/doc_classes/CSGPolygon3D.xml
+++ b/modules/csg/doc_classes/CSGPolygon3D.xml
@@ -5,8 +5,10 @@
</brief_description>
<description>
An array of 2D points is extruded to quickly and easily create a variety of 3D meshes. See also [CSGMesh3D] for using 3D meshes as CSG nodes.
+ [b]Note:[/b] CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a [MeshInstance3D] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
</description>
<tutorials>
+ <link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
</tutorials>
<members>
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">