godot/doc/classes/Joint2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Abstract base class for all 2D physics joints.
	</brief_description>
	<description>
		Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies ([member node_a] and [member node_b]) and apply a constraint.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_rid" qualifiers="const">
			<return type="RID" />
			<description>
				Returns the joint's internal [RID] from the [PhysicsServer2D].
			</description>
		</method>
	</methods>
	<members>
		<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.0">
			When [member node_a] and [member node_b] move in different directions the [member bias] controls how fast the joint pulls them back to their original position. The lower the [member bias] the more the two bodies can pull on the joint.
			When set to [code]0[/code], the default value from [member ProjectSettings.physics/2d/solver/default_constraint_bias] is used.
		</member>
		<member name="disable_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 body (A) attached to the joint. The node must inherit [PhysicsBody2D].
		</member>
		<member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath(&quot;&quot;)">
			Path to the second body (B) attached to the joint. The node must inherit [PhysicsBody2D].
		</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 20:42:36 +00: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 08:08:05 +00:00			`<class name="Joint2D" inherits="Node2D" 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 20:42:36 +00:00			`<brief_description>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 20:59:03 +00:00			`Abstract base class for all 2D 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 20:42:36 +00:00			`</brief_description>`
			`<description>`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 17:25:56 +00:00			`Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies ([member node_a] and [member node_b]) and apply a constraint.`
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 20:42:36 +00:00			`</description>`
			`<tutorials>`
			`</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 14:30:18 +00:00			`<methods>`
			`<method name="get_rid" qualifiers="const">`
			`<return type="RID" />`
			`<description>`
Tweak Joint2D and Joint3D documentation for consistency 2024-01-21 17:25:56 +00:00			`Returns the joint's internal [RID] from the [PhysicsServer2D].`
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 14:30:18 +00: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 20:42:36 +00:00			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="bias" type="float" setter="set_bias" getter="get_bias" default="0.0">`
Validate `code` tags for class and member references This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors. 2023-10-02 18:11:43 +00:00			`When [member node_a] and [member node_b] move in different directions the [member bias] controls how fast the joint pulls them back to their original position. The lower the [member bias] the more the two bodies can pull on the joint.`
Add physics solver settings to project settings Helps with discovery and setup of physics solver settings, in a specific project settings section for both 2D and 3D. Other changes for cleanup: -Removed unused space parameters in 3D SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS -Added custom solver bias for Shape3D (same as Shape2D) -Improved documentation for solver settings 2021-12-07 01:10:13 +00:00			`When set to [code]0[/code], the default value from [member ProjectSettings.physics/2d/solver/default_constraint_bias] is used.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="disable_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 17:25:56 +00: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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00: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 17:25:56 +00:00			`Path to the first body (A) attached to the joint. The node must inherit [PhysicsBody2D].`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00: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 17:25:56 +00:00			`Path to the second body (B) attached to the joint. The node must inherit [PhysicsBody2D].`
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 20:42:36 +00:00			`</member>`
			`</members>`
			`</class>`