Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.


Inherits: Node2D < CanvasItem < Node < Object

A joint used with Skeleton2D to control and animate other nodes.


A hierarchy of Bone2Ds can be bound to a Skeleton2D to control and animate other Node2D nodes.

You can use Bone2D and Skeleton2D nodes to animate 2D meshes created with the Polygon2D UV editor.

Each bone has a rest transform that you can reset to with apply_rest. These rest poses are relative to the bone's parent.

If in the editor, you can set the rest pose of an entire skeleton using a menu option, from the code, you need to iterate over the bones to set their individual rest poses.




Transform2D(0, 0, 0, 0, 0, 0)



apply_rest ( )


get_autocalculate_length_and_angle ( ) const


get_bone_angle ( ) const


get_index_in_skeleton ( ) const


get_length ( ) const


get_skeleton_rest ( ) const


set_autocalculate_length_and_angle ( bool auto_calculate )


set_bone_angle ( float angle )


set_length ( float length )

Property Descriptions

Transform2D rest = Transform2D(0, 0, 0, 0, 0, 0)

Rest transform of the bone. You can reset the node's transforms to this value using apply_rest.

Method Descriptions

void apply_rest ( )

Stores the node's current transforms in rest.

bool get_autocalculate_length_and_angle ( ) const

Returns whether this Bone2D is going to autocalculate its length and bone angle using its first Bone2D child node, if one exists. If there are no Bone2D children, then it cannot autocalculate these values and will print a warning.

float get_bone_angle ( ) const

Returns the angle of the bone in the Bone2D.

Note: This is different from the Bone2D's rotation. The bone's angle is the rotation of the bone shown by the gizmo, which is unaffected by the Bone2D's Node2D.transform.

int get_index_in_skeleton ( ) const

Returns the node's index as part of the entire skeleton. See Skeleton2D.

float get_length ( ) const

Returns the length of the bone in the Bone2D node.

Transform2D get_skeleton_rest ( ) const

Returns the node's rest Transform2D if