unreal.AnimationCurveIdentifierExtensions

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

Bases: BlueprintFunctionLibrary

Script-exposed functionality for wrapping native functionality and constructing valid FAnimationCurveIdentifier instances

C++ Source:

  • Module: Engine

  • File: CurveIdentifier.h

classmethod find_curve_identifier(skeleton, 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:
  • skeleton (Skeleton) – Skeleton on which to look for the curve name

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

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

Returns:

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

Return type:

AnimationCurveIdentifier

classmethod get_curve_identifier(skeleton, 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:
  • skeleton (Skeleton) – Skeleton on which to look for or add the curve name

  • 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

classmethod get_curve_identifiers(skeleton, curve_type) Array[AnimationCurveIdentifier]

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

Parameters:
  • skeleton (Skeleton) – Skeleton from which to retrieve the curve identifiers

  • 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]

classmethod get_name(identifier) -> (Name, identifier=AnimationCurveIdentifier)
Parameters:

identifier (AnimationCurveIdentifier) –

Returns:

The name used for displaying the Curve Identifier

identifier (AnimationCurveIdentifier):

Return type:

AnimationCurveIdentifier

classmethod get_transform_child_curve_identifier(out_identifier, channel, axis) AnimationCurveIdentifier or None

Converts a valid FAnimationCurveIdentifier instance with RCT_Transform curve type to target a child curve.

Parameters:
Returns:

Valid FAnimationCurveIdentifier if the operation was successful

out_identifier (AnimationCurveIdentifier): [out] Identifier to be converted

Return type:

AnimationCurveIdentifier or None

classmethod get_type(identifier) -> (RawCurveTrackTypes, identifier=AnimationCurveIdentifier)
Parameters:

identifier (AnimationCurveIdentifier) –

Returns:

The animation curve type for the curve represented by the Curve Identifier

identifier (AnimationCurveIdentifier):

Return type:

AnimationCurveIdentifier

classmethod is_valid(identifier) AnimationCurveIdentifier or None
Parameters:

identifier (AnimationCurveIdentifier) –

Returns:

Whether or not the Curve Identifier is valid

identifier (AnimationCurveIdentifier):

Return type:

AnimationCurveIdentifier or None