virtualx-engine/modules/csg/doc_classes/CSGPrimitive3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CSGPrimitive3D" inherits="CSGShape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Base class for CSG primitives.
	</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="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces" default="false">
			If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
		</member>
	</members>
</class>
Sync classref with current source 2018-05-12 09:38:00 +02: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 14:18:53 +01:00			`<class name="CSGPrimitive3D" inherits="CSGShape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`<brief_description>`
Added some documentation for the CSG nodes 2018-07-19 11:31:12 +02:00			`Base class for CSG primitives.`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`</brief_description>`
			`<description>`
Finish documenting CSG* and *probes 2020-01-23 07:12:52 +01:00			`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.`
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 13:58:08 +01: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.`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`</description>`
			`<tutorials>`
Document performance limitations with CSG nodes, link to tutorial 2022-02-07 13:58:08 +01:00			`<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`</tutorials>`
			`<members>`
Rename `CSGPrimitive3D.invert_faces` to `flip_faces` 2022-05-07 03:51:46 +02:00			`<member name="flip_faces" type="bool" setter="set_flip_faces" getter="get_flip_faces" default="false">`
			`If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.`
Sync classref with current source 2018-05-12 09:38:00 +02:00			`</member>`
			`</members>`
			`</class>`