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 force_interrupt_next_update(motion_matching_node) → None

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

Parameters:

motion_matching_node (MotionMatchingAnimNodeReference) – The motion matching node to operate on.

classmethod reset_databases_to_search(motion_matching_node, force_interrupt) → None

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

Parameters:

• motion_matching_node (MotionMatchingAnimNodeReference) – The motion matching node to operate on.

• force_interrupt (bool) – Force a search after the reset. If false, the continuing pose (the current clip that’s playing) will continue to play until a better match is found from the Database property.

classmethod set_database_to_search(motion_matching_node, database, force_interrupt_if_new) → None

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

Parameters:

• motion_matching_node (MotionMatchingAnimNodeReference) – The motion matching node to operate on.

• database (PoseSearchDatabase) – The database for the motion matching node to search.

• force_interrupt_if_new (bool) – If true, ignore the continuing pose (the current clip that’s playing) and force a search of the new database. If false, the continuing pose will continue to play until a better match is found in the new database. This setting is ignored if the motion matching node is already searching this database.

classmethod set_databases_to_search(motion_matching_node, databases, force_interrupt_if_new) → None

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

Parameters:

• motion_matching_node (MotionMatchingAnimNodeReference) – The motion matching node to operate on.

• databases (Array[PoseSearchDatabase]) – Array of databases for the motion matching node to search.

• force_interrupt_if_new (bool) – If true, ignore the continuing pose (the current clip that’s playing) and force a search of the new databases. If false, the continuing pose will continue to play until a better match is found in one of the new databases. This setting is ignored if the motion matching node is already searching this array of databases (note: a subset of databases or the same databases in a different order is considered to be a new array of databases).