virtualx-engine/doc/classes/Joint3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint3D" inherits="Node3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for all 3D joints.
	</brief_description>
	<description>
		Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other. See also [Generic6DOFJoint3D].
	</description>
	<tutorials>
		<link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/524</link>
	</tutorials>
	<members>
		<member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" default="true">
			If [code]true[/code], the two bodies of the nodes are not able to collide with each other.
		</member>
		<member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath(&quot;&quot;)">
			The node attached to the first side (A) of the joint.
		</member>
		<member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath(&quot;&quot;)">
			The node attached to the second side (B) of the joint.
		</member>
		<member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority" default="1">
			The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.
		</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="Joint3D" inherits="Node3D" 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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`Base class for all 3D joints.`
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>`
			`<description>`
Fix confusing SliderJoint3D brief description 2020-12-24 01:46:56 +01:00			`Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other. See also [Generic6DOFJoint3D].`
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>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/524</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: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" default="true">`
doc: Add missing commas after "If true/false" 2018-12-20 13:46:54 +01:00			`If [code]true[/code], the two bodies of the nodes are not able to collide with each other.`
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>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath("")">`
doc: Fix wrong references found by new makerst.py Thanks @PJB3005 2019-01-07 10:02:04 +01:00			`The node attached to the first side (A) of the joint.`
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>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath("")">`
doc: Fix wrong references found by new makerst.py Thanks @PJB3005 2019-01-07 10:02:04 +01:00			`The node attached to the second side (B) of the joint.`
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>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority" default="1">`
doc: Fix wrong references found by new makerst.py Thanks @PJB3005 2019-01-07 10:02:04 +01:00			`The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.`
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>`