Document performance limitations with CSG nodes, link to tutorial

This commit is contained in:
Hugo Locurcio 2022-02-07 13:58:08 +01:00
parent bc1a3d791d
commit 5268786ac0
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
9 changed files with 18 additions and 0 deletions

View file

@ -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">