summaryrefslogtreecommitdiff
path: root/modules/csg/doc_classes/CSGPrimitive3D.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/CSGPrimitive3D.xml
parent650e218b9606e4640ac10ecbff1b7f08b6be0daf (diff)
parent5268786ac0213d4881f8a214b4d81f0c33340802 (diff)
Merge pull request #57752 from Calinou/doc-csg-nodes-performance
Diffstat (limited to 'modules/csg/doc_classes/CSGPrimitive3D.xml')
-rw-r--r--modules/csg/doc_classes/CSGPrimitive3D.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/modules/csg/doc_classes/CSGPrimitive3D.xml b/modules/csg/doc_classes/CSGPrimitive3D.xml
index 8f4c8b9451..7eac85368e 100644
--- a/modules/csg/doc_classes/CSGPrimitive3D.xml
+++ b/modules/csg/doc_classes/CSGPrimitive3D.xml
@@ -5,8 +5,10 @@
</brief_description>
<description>
Parent class for various CSG primitives. It contains code and functionality that is common between them. It cannot be used directly. Instead use one of the various classes that inherit from it.
+ [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="invert_faces" type="bool" setter="set_invert_faces" getter="is_inverting_faces" default="false">