unreal.Skeleton

class unreal.Skeleton(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Object

USkeletonthat links between mesh and animation

  • Bone hierarchy for animations

  • Bone/track linkup between mesh and animation

  • Retargetting related

C++ Source:

  • Module: Engine

  • File: Skeleton.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Asset User Data: Array of user data stored with the asset

  • bone_tree (Array[BoneNode]): [Read-Only] Bone Tree: Skeleton bone tree - each contains name and parent index*

  • compatible_skeletons (Array[Skeleton]): [Read-Write] Compatible Skeletons: The list of compatible skeletons. This is an array of TSoftObjectPtr in order to prevent all skeletons to be loaded, as we only want to load things on demand. As this is EditAnywhere and an array of TSoftObjectPtr, checking validity of pointers is needed.

add_compatible_skeleton(source_skeleton) → None

Add Compatible Skeleton

Parameters:

source_skeleton (Skeleton) –

property compatible_skeletons: Array[Skeleton]

[Read-Only] Compatible Skeletons: The list of compatible skeletons. This is an array of TSoftObjectPtr in order to prevent all skeletons to be loaded, as we only want to load things on demand. As this is EditAnywhere and an array of TSoftObjectPtr, checking validity of pointers is needed.

Type:

(Array[Skeleton])

find_curve_identifier(name, curve_type) → AnimationCurveIdentifier

Tries to construct a valid FAnimationCurveIdentifier instance. It tries to find the underlying SmartName on the provided Skeleton for the provided curve type.

Parameters:
Returns:

Valid FAnimationCurveIdentifier if the name exists on the skeleton and the operation was successful, invalid otherwise

Return type:

AnimationCurveIdentifier

get_blend_profile(profile_name) → BlendProfile

Get the specified blend profile by name

Parameters:

profile_name (Name) –

Return type:

BlendProfile

get_curve_identifier(name, curve_type) → AnimationCurveIdentifier

Constructs a valid FAnimationCurveIdentifier instance. Ensuring that the underlying SmartName exists on the provided Skeleton for the provided curve type. If it is not found initially it will add it to the Skeleton thus modifying it.

Parameters:

  • name (Name) – Name of the curve to find or add

  • curve_type (RawCurveTrackTypes) – Type of the curve to find or add

Returns:

Valid FAnimationCurveIdentifier if the operation was successful

Return type:

AnimationCurveIdentifier

get_curve_identifiers(curve_type) → Array[AnimationCurveIdentifier]

Retrieves all curve identifiers for a specific curve types from the provided Skeleton

Parameters:

curve_type (RawCurveTrackTypes) – Type of the curve identifers to retrieve

Returns:

Array of FAnimationCurveIdentifier instances each representing a unique curve if the operation was successful, empyty array otherwise

Return type:

Array[AnimationCurveIdentifier]

get_reference_pose() → AnimPose

Populates an Anim Pose with the reference poses stored for the provided USkeleton

Returns:

out_pose (AnimPose): Anim pose to hold the reference pose

Return type:

AnimPose