mirror of
https://github.com/godotengine/godot
synced 2024-09-15 22:38:28 +00:00
cc0eebd9d8
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.
35 lines
1.7 KiB
XML
35 lines
1.7 KiB
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 and apply a constraint.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_rid" qualifiers="const">
|
|
<return type="RID" />
|
|
<description>
|
|
Returns the joint's [RID].
|
|
</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], [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("")">
|
|
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("")">
|
|
The second body attached to the joint. Must derive from [PhysicsBody2D].
|
|
</member>
|
|
</members>
|
|
</class>
|