unreal.MotionMatchingAnimNodeLibrary

class unreal.MotionMatchingAnimNodeLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Exposes operations that can be run on a Motion Matching node via Anim Node Functions such as “On Become Relevant” and “On Update”.

C++ Source:

  • Plugin: PoseSearch

  • Module: PoseSearch

  • File: MotionMatchingAnimNodeLibrary.h

classmethod convert_to_motion_matching_node(node) -> (MotionMatchingAnimNodeReference, result=AnimNodeReferenceConversionResult)

Get a motion matching node context from an anim node context

Parameters:

node (AnimNodeReference)

Returns:

result (AnimNodeReferenceConversionResult):

Return type:

AnimNodeReferenceConversionResult

classmethod convert_to_motion_matching_node_pure(node) -> (motion_matching_node=MotionMatchingAnimNodeReference, result=bool)

Get a motion matching node context from an anim node context (pure)

Parameters:

node (AnimNodeReference)

Returns:

motion_matching_node (MotionMatchingAnimNodeReference):

result (bool):

Return type:

tuple

classmethod get_motion_matching_blend_settings(motion_matching_node) -> (blend_settings=MotionMatchingBlueprintBlendSettings, is_result_valid=bool)

Get current blend settings used when blending into a new asset

Parameters:

motion_matching_node (MotionMatchingAnimNodeReference)

Returns:

blend_settings (MotionMatchingBlueprintBlendSettings):

is_result_valid (bool):

Return type:

tuple

classmethod get_motion_matching_search_result(motion_matching_node) -> (result=PoseSearchBlueprintResult, is_result_valid=bool)

Get Motion Matching Search Result

Parameters:

motion_matching_node (MotionMatchingAnimNodeReference)

Returns:

result (PoseSearchBlueprintResult):

is_result_valid (bool):

Return type:

tuple

classmethod override_motion_matching_blend_settings(motion_matching_node, blend_settings) → bool

Override current blend settings for motion matching. Note that any pinned parameters will stomp this override on the next update.

Parameters:
Returns:

is_result_valid (bool):

Return type:

bool

Clear the effects of SetDatabaseToSearch/SetDatabasesToSearch and resume searching the Database property on the motion matching node.

Parameters:

Set the database to search on the motion matching node. This overrides the Database property on the motion matching node.

Parameters:

Set the database to search on the motion matching node. This overrides the Database property on the motion matching node.

Parameters:
classmethod set_interrupt_mode(motion_matching_node, interrupt_mode) → None

Ignore the continuing pose (the current clip that’s playing) and force a new search.

Parameters: