Description

SkeletonModifier3D retrieves a targetSkeleton3D by having aSkeleton3D parent.

If there isAnimationMixer, modification always performs after playback process of theAnimationMixer.

This node should be used to implement custom IK solvers, constraints, or skeleton physics.

Tutorials

• Design of the Skeleton Modifier 3D

Properties

Methods

Signals

modification_processed()🔗

Notifies when the modification have been finished.

Note: If you want to get the modified bone pose by the modifier, you must useSkeleton3D.get_bone_pose() orSkeleton3D.get_bone_global_pose() at the moment this signal is fired.

Enumerations

enumBoneAxis:🔗

BoneAxisBONE_AXIS_PLUS_X =0

Enumerated value for the +X axis.

BoneAxisBONE_AXIS_MINUS_X =1

Enumerated value for the -X axis.

BoneAxisBONE_AXIS_PLUS_Y =2

Enumerated value for the +Y axis.

BoneAxisBONE_AXIS_MINUS_Y =3

Enumerated value for the -Y axis.

BoneAxisBONE_AXIS_PLUS_Z =4

Enumerated value for the +Z axis.

BoneAxisBONE_AXIS_MINUS_Z =5

Enumerated value for the -Z axis.

Property Descriptions

boolactive =true🔗

• voidset_active(value:bool)

• boolis_active()

Iftrue, theSkeletonModifier3D will be processing.

floatinfluence =1.0🔗

• voidset_influence(value:float)

• floatget_influence()

Sets the influence of the modification.

Note: This value is used bySkeleton3D to blend, so theSkeletonModifier3D should always apply only 100% of the result without interpolation.

Method Descriptions

void_process_modification()virtual🔗

Override this virtual method to implement a custom skeleton modifier. You should do things like get theSkeleton3D's current pose and apply the pose here.

_process_modification() must not applyinfluence to bone poses because theSkeleton3D automatically applies influence to all bone poses set by the modifier.

Skeleton3Dget_skeleton()const🔗

Get parentSkeleton3D node if found.