virtualx-engine/doc/classes/Joint3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Abstract base class for all 3D physics joints.
	</brief_description>
	<description>
		Abstract base class for all joints in 3D physics. 3D joints bind together two physics bodies ([member node_a] and [member node_b]) and apply a constraint. If only one body is defined, it is attached to a fixed [StaticBody3D] without collision shapes.
	</description>
	<tutorials>
		<link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/2752</link>
	</tutorials>
	<methods>
		<method name="get_rid" qualifiers="const">
			<return type="RID" />
			<description>
				Returns the joint's internal [RID] from the [PhysicsServer3D].
			</description>
		</method>
	</methods>
	<members>
		<member name="exclude_nodes_from_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" default="true">
			If [code]true[/code], the two bodies bound together do not collide with each other.
		</member>
		<member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath(&quot;&quot;)">
			Path to the first node (A) attached to the joint. The node must inherit [PhysicsBody3D].
			If left empty and [member node_b] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.
		</member>
		<member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath(&quot;&quot;)">
			Path to the second node (B) attached to the joint. The node must inherit [PhysicsBody3D].
			If left empty and [member node_a] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.
		</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" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="Joint3D" inherits="Node3D" 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>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 22:59:03 +02:00			`Abstract base class for all 3D physics 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>`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 18:25:56 +01:00			`Abstract base class for all joints in 3D physics. 3D joints bind together two physics bodies ([member node_a] and [member node_b]) and apply a constraint. If only one body is defined, it is attached to a fixed [StaticBody3D] without collision shapes.`
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>`
Update links to outdated asset library demos Update links to outdated asset library demos Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com> 2024-03-25 02:20:59 +01:00			`<link title="3D Truck Town Demo">https://godotengine.org/asset-library/asset/2752</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>`
Expose the get_rid method of Joint2D and Joint3D update occurance of get_joint Update documentation as per feedback. update update Co-Authored-By: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> 2023-08-17 16:30:18 +02:00			`<methods>`
			`<method name="get_rid" qualifiers="const">`
			`<return type="RID" />`
			`<description>`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 18:25:56 +01:00			`Returns the joint's internal [RID] from the [PhysicsServer3D].`
Expose the get_rid method of Joint2D and Joint3D update occurance of get_joint Update documentation as per feedback. update update Co-Authored-By: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> 2023-08-17 16:30:18 +02:00			`</description>`
			`</method>`
			`</methods>`
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			`<members>`
Rename properties unnecessarily using slash (`/`) in their names This is a legacy of Godot 2 days before the inspector had support for groups. "Properties" with a slash in their name can't be accessed from script unless using `set()`/`get()` so they were not actual properties as far as script languages are concerned. Part of #17558. 2022-08-22 11:26:47 +02:00			`<member name="exclude_nodes_from_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision" default="true">`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 18:25:56 +01:00			`If [code]true[/code], the two bodies bound together do not 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>`
Rename properties unnecessarily using slash (`/`) in their names This is a legacy of Godot 2 days before the inspector had support for groups. "Properties" with a slash in their name can't be accessed from script unless using `set()`/`get()` so they were not actual properties as far as script languages are concerned. Part of #17558. 2022-08-22 11:26:47 +02:00			`<member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath("")">`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 18:25:56 +01:00			`Path to the first node (A) attached to the joint. The node must inherit [PhysicsBody3D].`
			`If left empty and [member node_b] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.`
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>`
Rename properties unnecessarily using slash (`/`) in their names This is a legacy of Godot 2 days before the inspector had support for groups. "Properties" with a slash in their name can't be accessed from script unless using `set()`/`get()` so they were not actual properties as far as script languages are concerned. Part of #17558. 2022-08-22 11:26:47 +02:00			`<member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath("")">`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 18:25:56 +01:00			`Path to the second node (B) attached to the joint. The node must inherit [PhysicsBody3D].`
			`If left empty and [member node_a] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.`
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>`
Rename properties unnecessarily using slash (`/`) in their names This is a legacy of Godot 2 days before the inspector had support for groups. "Properties" with a slash in their name can't be accessed from script unless using `set()`/`get()` so they were not actual properties as far as script languages are concerned. Part of #17558. 2022-08-22 11:26:47 +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>`