virtualx-engine/doc/classes/MultiMeshInstance3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="MultiMeshInstance3D" inherits="GeometryInstance3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Node that instances a [MultiMesh].
	</brief_description>
	<description>
		[MultiMeshInstance3D] is a specialized node to instance [GeometryInstance3D]s based on a [MultiMesh] resource.
		This is useful to optimize the rendering of a high number of instances of a given mesh (for example trees in a forest or grass strands).
	</description>
	<tutorials>
		<link title="Animating thousands of fish with MultiMeshInstance">$DOCS_URL/tutorials/performance/vertex_animation/animating_thousands_of_fish.html</link>
		<link title="Using MultiMeshInstance">$DOCS_URL/tutorials/3d/using_multi_mesh_instance.html</link>
		<link title="Optimization using MultiMeshes">$DOCS_URL/tutorials/performance/using_multimesh.html</link>
	</tutorials>
	<members>
		<member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh">
			The [MultiMesh] resource that will be used and shared among all instances of the [MultiMeshInstance3D].
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +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="MultiMeshInstance3D" inherits="GeometryInstance3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
			`Node that instances a [MultiMesh].`
			`</brief_description>`
			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`[MultiMeshInstance3D] is a specialized node to instance [GeometryInstance3D]s based on a [MultiMesh] resource.`
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases. 2022-08-18 00:08:09 +02:00			`This is useful to optimize the rendering of a high number of instances of a given mesh (for example trees in a forest or grass strands).`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`<link title="Animating thousands of fish with MultiMeshInstance">$DOCS_URL/tutorials/performance/vertex_animation/animating_thousands_of_fish.html</link>`
			`<link title="Using MultiMeshInstance">$DOCS_URL/tutorials/3d/using_multi_mesh_instance.html</link>`
			`<link title="Optimization using MultiMeshes">$DOCS_URL/tutorials/performance/using_multimesh.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`<members>`
doc: Sync classref with current source 2019-07-15 20:42:47 +02:00			`<member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`The [MultiMesh] resource that will be used and shared among all instances of the [MultiMeshInstance3D].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`</class>`