godot/doc/classes/Joint2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Joint2D" inherits="Node2D" version="4.1" 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 and apply a constraint.
	</description>
	<tutorials>
	</tutorials>
	<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 [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] 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], [member node_a] and [member node_b] can not collide.
		</member>
		<member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a" default="NodePath(&quot;&quot;)">
			The first body attached to the joint. Must derive from [PhysicsBody2D].
		</member>
		<member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b" default="NodePath(&quot;&quot;)">
			The second body attached to the joint. Must derive from [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" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 00:44:37 +00:00			`<class name="Joint2D" inherits="Node2D" version="4.1" 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>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 20:59:03 +00:00			`Abstract base class for all joints in 2D physics. 2D joints bind together two physics bodies 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>`
			`<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">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 13:24:23 +00:00			`When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] 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">`
Fix Joint2D doc 2020-06-22 02:55:16 +00:00			`If [code]true[/code], [member node_a] and [member node_b] can not collide.`
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("")">`
Added the 2D Joint docs 2017-10-16 12:11:43 +00:00			`The first body attached to the joint. Must derive from [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("")">`
Added the 2D Joint docs 2017-10-16 12:11:43 +00:00			`The second body attached to the joint. Must derive from [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>`