godot/modules/csg/doc_classes/CSGCombiner3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CSGCombiner3D" inherits="CSGShape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A CSG node that allows you to combine other CSG modifiers.
	</brief_description>
	<description>
		For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner3D node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner3D node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner3D node, and then do an operation that takes the two end results as its input to create the final shape.
		[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>
</class>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="CSGCombiner3D" inherits="CSGShape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<brief_description>`
			`A CSG node that allows you to combine other CSG modifiers.`
			`</brief_description>`
			`<description>`
			For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner3D node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner3D node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner3D node, and then do an operation that takes the two end results as its input to create the final shape.
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 12:58:08 +00:00			`[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.`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`</description>`
			`<tutorials>`
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 12:58:08 +00:00			`<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`</tutorials>`
			`</class>`