58 lines
3.2 KiB
XML
58 lines
3.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="SpringArm3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
A 3D raycast that dynamically moves its children near the collision point.
|
|
</brief_description>
|
|
<description>
|
|
[SpringArm3D] casts a ray or a shape along its Z axis and moves all its direct children to the collision point, with an optional margin. This is useful for 3rd person cameras that move closer to the player when inside a tight space (you may need to exclude the player's collider from the [SpringArm3D]'s collision check.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_excluded_object">
|
|
<return type="void" />
|
|
<param index="0" name="RID" type="RID" />
|
|
<description>
|
|
Adds the [PhysicsBody3D] object with the given [RID] to the list of [PhysicsBody3D] objects excluded from the collision check.
|
|
</description>
|
|
</method>
|
|
<method name="clear_excluded_objects">
|
|
<return type="void" />
|
|
<description>
|
|
Clears the list of [PhysicsBody3D] objects excluded from the collision check.
|
|
</description>
|
|
</method>
|
|
<method name="get_hit_length">
|
|
<return type="float" />
|
|
<description>
|
|
Returns the spring arm's current length.
|
|
</description>
|
|
</method>
|
|
<method name="remove_excluded_object">
|
|
<return type="bool" />
|
|
<param index="0" name="RID" type="RID" />
|
|
<description>
|
|
Removes the given [RID] from the list of [PhysicsBody3D] objects excluded from the collision check.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
|
|
The layers against which the collision check shall be done. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
|
|
</member>
|
|
<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.01">
|
|
When the collision check is made, a candidate length for the SpringArm3D is given.
|
|
The margin is then subtracted to this length and the translation is applied to the child objects of the SpringArm3D.
|
|
This margin is useful for when the SpringArm3D has a [Camera3D] as a child node: without the margin, the [Camera3D] would be placed on the exact point of collision, while with the margin the [Camera3D] would be placed close to the point of collision.
|
|
</member>
|
|
<member name="shape" type="Shape3D" setter="set_shape" getter="get_shape">
|
|
The [Shape3D] to use for the SpringArm3D.
|
|
When the shape is set, the SpringArm3D will cast the [Shape3D] on its z axis instead of performing a ray cast.
|
|
</member>
|
|
<member name="spring_length" type="float" setter="set_length" getter="get_length" default="1.0">
|
|
The maximum extent of the SpringArm3D. This is used as a length for both the ray and the shape cast used internally to calculate the desired position of the SpringArm3D's child nodes.
|
|
To know more about how to perform a shape cast or a ray cast, please consult the [PhysicsDirectSpaceState3D] documentation.
|
|
</member>
|
|
</members>
|
|
</class>
|