967bfb0c4a
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
92 lines
2.9 KiB
XML
92 lines
2.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Joint2D" inherits="Node2D" category="Core" version="3.0-alpha">
|
|
<brief_description>
|
|
Base node for all joint constraints in 2D physics.
|
|
</brief_description>
|
|
<description>
|
|
Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="get_bias" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_exclude_nodes_from_collision" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_node_a" qualifiers="const">
|
|
<return type="NodePath">
|
|
</return>
|
|
<description>
|
|
Return the path to the A node for the joint.
|
|
</description>
|
|
</method>
|
|
<method name="get_node_b" qualifiers="const">
|
|
<return type="NodePath">
|
|
</return>
|
|
<description>
|
|
Return the path to the B node for the joint.
|
|
</description>
|
|
</method>
|
|
<method name="set_bias">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="bias" type="float">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_exclude_nodes_from_collision">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enable" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_node_a">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="node" type="NodePath">
|
|
</argument>
|
|
<description>
|
|
Set the path to the A node for the joint. Must be of type [PhysicsBody2D].
|
|
</description>
|
|
</method>
|
|
<method name="set_node_b">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="node" type="NodePath">
|
|
</argument>
|
|
<description>
|
|
Set the path to the B node for the joint. Must be of type [PhysicsBody2D].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="bias" type="float" setter="set_bias" getter="get_bias">
|
|
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. Default value: [code]0[/code]
|
|
</member>
|
|
<member name="disable_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision">
|
|
If [code]true[/code] [member node_a] and [member node_b] can collide. Default value: [code]false[/code].
|
|
</member>
|
|
<member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a">
|
|
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">
|
|
The second body attached to the joint. Must derive from [PhysicsBody2D].
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|