Skeleton2D

Inherits: Node2D < CanvasItem < Node < Object

Skeleton for 2D characters and animated objects.

Description

Skeleton2D parents a hierarchy of Bone2D objects. It is a requirement of Bone2D. Skeleton2D holds a reference to the rest pose of its children and acts as a single point of access to its bones.

Tutorials

Methods

Bone2D get_bone ( int idx )
int get_bone_count ( ) const
RID get_skeleton ( ) const

Signals

  • bone_setup_changed ( )

Method Descriptions

Returns a Bone2D from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter idx. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling.

  • int get_bone_count ( ) const

Returns the number of Bone2D nodes in the node hierarchy parented by Skeleton2D.

  • RID get_skeleton ( ) const

Returns the RID of a Skeleton2D instance.