Table of Contents

Class Skeleton2D

The parent of a hierarchy of Bone2Ds, used to create a 2D skeletal animation.

Inheritance
Skeleton2D

Remarks

Skeleton2D parents a hierarchy of Bone2D nodes. It holds a reference to each Bone2D's rest pose and acts as a single point of access to its bones.

To set up different types of inverse kinematics for the given Skeleton2D, a SkeletonModificationStack2D should be created. The inverse kinematics be applied by increasing modification_count and creating the desired number of modifications.

See Also

2D skeletons

Methods

execute_modifications(float, int)

Executes all the modifications on the SkeletonModificationStack2D, if the Skeleton2D has one assigned.

void execute_modifications(float delta, int execution_mode)

Parameters

delta float
execution_mode int

get_bone(int)

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.

Bone2D get_bone(int idx)

Parameters

idx int

get_bone_count

Qualifiers: const

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

int get_bone_count

get_bone_local_pose_override(int)

Returns the local pose override transform for bone_idx.

Transform2D get_bone_local_pose_override(int bone_idx)

Parameters

bone_idx int

get_modification_stack

Qualifiers: const

Returns the SkeletonModificationStack2D attached to this skeleton, if one exists.

SkeletonModificationStack2D get_modification_stack

get_skeleton

Qualifiers: const

Returns the RID of a Skeleton2D instance.

RID get_skeleton

set_bone_local_pose_override(int, Transform2D, float, bool)

Sets the local pose transform, override_pose, for the bone at bone_idx.

strength is the interpolation strength that will be used when applying the pose, and persistent determines if the applied pose will remain.

Note: The pose transform needs to be a local transform relative to the Bone2D node at bone_idx!

void set_bone_local_pose_override(int bone_idx, Transform2D override_pose, float strength, bool persistent)

Parameters

bone_idx int
override_pose Transform2D
strength float
persistent bool

set_modification_stack(SkeletonModificationStack2D)

Sets the SkeletonModificationStack2D attached to this skeleton.

void set_modification_stack(SkeletonModificationStack2D modification_stack)

Parameters

modification_stack SkeletonModificationStack2D

Events

bone_setup_changed

Emitted when the Bone2D setup attached to this skeletons changes. This is primarily used internally within the skeleton.

signal bone_setup_changed