unreal.ContextualAnimUtilities

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

Bases: BlueprintFunctionLibrary

Contextual Anim Utilities

C++ Source:

• Plugin: ContextualAnimation

• Module: ContextualAnimation

• File: ContextualAnimUtilities.h

classmethod bp_create_contextual_anim_scene_bindings(scene_asset, params) → ContextualAnimSceneBindings or None

BP Create Contextual Anim Scene Bindings

Parameters:

• scene_asset (ContextualAnimSceneAsset) –

• params (Map[Name, ContextualAnimSceneBindingContext]) –

Returns:

out_bindings (ContextualAnimSceneBindings):

Return type:

ContextualAnimSceneBindings or None

classmethod bp_create_contextual_anim_scene_bindings_for_two_actors(scene_asset, primary, secondary) → ContextualAnimSceneBindings or None

BP Create Contextual Anim Scene Bindings for Two Actors

Parameters:

• scene_asset (ContextualAnimSceneAsset) –

• primary (ContextualAnimSceneBindingContext) –

• secondary (ContextualAnimSceneBindingContext) –

Returns:

out_bindings (ContextualAnimSceneBindings):

Return type:

ContextualAnimSceneBindings or None

classmethod bp_draw_debug_pose(world_context_object, animation, time, local_to_world_transform, color, life_time, thickness) → None

BP Draw Debug Pose

Parameters:

• world_context_object (Object) –

• animation (AnimSequenceBase) –

• time (float) –

• local_to_world_transform (Transform) –

• color (LinearColor) –

• life_time (float) –

• thickness (float) –

classmethod bp_montage_get_section_length(montage, section_index) → float

BP Montage Get Section Length

Parameters:

• montage (AnimMontage) –

• section_index (int32) –

Return type:

float

classmethod bp_montage_get_section_start_and_end_time(montage, section_index) -> (out_start_time=float, out_end_time=float)

Montage Blueprint Interface

Parameters:

• montage (AnimMontage) –

• section_index (int32) –

Returns:

out_start_time (float):

out_end_time (float):

Return type:

tuple

classmethod bp_montage_get_section_time_left_from_pos(montage, position) → float

BP Montage Get Section Time Left from Pos

Parameters:

• montage (AnimMontage) –

• position (float) –

Return type:

float

classmethod bp_scene_binding_context_get_actor(binding_context) → Actor

BP Scene Binding Context Get Actor

Parameters:

binding_context (ContextualAnimSceneBindingContext) –

Return type:

Actor

classmethod bp_scene_binding_context_get_gameplay_tags(binding_context) → GameplayTagContainer

BP Scene Binding Context Get Gameplay Tags

Parameters:

binding_context (ContextualAnimSceneBindingContext) –

Return type:

GameplayTagContainer

classmethod bp_scene_binding_context_get_transform(binding_context) → Transform

BP Scene Binding Context Get Transform

Parameters:

binding_context (ContextualAnimSceneBindingContext) –

Return type:

Transform

classmethod bp_scene_binding_context_get_velocity(binding_context) → Vector

BP Scene Binding Context Get Velocity

Parameters:

binding_context (ContextualAnimSceneBindingContext) –

Return type:

Vector

classmethod bp_scene_binding_context_has_all_matching_gameplay_tags(binding_context, tag_container) → bool

BP Scene Binding Context Has All Matching Gameplay Tags

Parameters:

• binding_context (ContextualAnimSceneBindingContext) –

• tag_container (GameplayTagContainer) –

Return type:

bool

classmethod bp_scene_binding_context_has_any_matching_gameplay_tags(binding_context, tag_container) → bool

BP Scene Binding Context Has Any Matching Gameplay Tags

Parameters:

• binding_context (ContextualAnimSceneBindingContext) –

• tag_container (GameplayTagContainer) –

Return type:

bool

classmethod bp_scene_binding_context_has_matching_gameplay_tag(binding_context, tag_to_check) → bool

BP Scene Binding Context Has Matching Gameplay Tag

Parameters:

• binding_context (ContextualAnimSceneBindingContext) –

• tag_to_check (GameplayTag) –

Return type:

bool

classmethod bp_scene_binding_context_make_from_actor_with_external_transform(actor, external_transform) → ContextualAnimSceneBindingContext

BP Scene Binding Context Make from Actor with External Transform

Parameters:

• actor (Actor) –

• external_transform (Transform) –

Return type:

ContextualAnimSceneBindingContext

classmethod bp_scene_binding_get_actor(binding) → Actor

FContextualAnimSceneBinding Blueprint Interface

Parameters:

binding (ContextualAnimSceneBinding) –

Return type:

Actor

classmethod bp_scene_binding_get_animation_from_binding(bindings, binding) → AnimSequenceBase

BP Scene Binding Get Animation from Binding

Parameters:

• bindings (ContextualAnimSceneBindings) –

• binding (ContextualAnimSceneBinding) –

Return type:

AnimSequenceBase

classmethod bp_scene_binding_get_role_from_binding(bindings, binding) → Name

BP Scene Binding Get Role from Binding

Parameters:

• bindings (ContextualAnimSceneBindings) –

• binding (ContextualAnimSceneBinding) –

Return type:

Name

classmethod bp_scene_binding_get_skeletal_mesh(binding) → SkeletalMeshComponent

BP Scene Binding Get Skeletal Mesh

Parameters:

binding (ContextualAnimSceneBinding) –

Return type:

SkeletalMeshComponent

classmethod bp_scene_bindings_add_or_update_warp_targets_for_bindings(bindings) → None

BP Scene Bindings Add or Update Warp Targets for Bindings

Parameters:

bindings (ContextualAnimSceneBindings) –

classmethod bp_scene_bindings_calculate_warp_points(bindings) → Array[ContextualAnimWarpPoint]

SceneBindings Blueprint Interface

Parameters:

bindings (ContextualAnimSceneBindings) –

Returns:

out_warp_points (Array[ContextualAnimWarpPoint]):

Return type:

Array[ContextualAnimWarpPoint]

classmethod bp_scene_bindings_get_alignment_transform_for_role_relative_to_other_role(bindings, role, relative_to_role, time) → Transform

BP Scene Bindings Get Alignment Transform for Role Relative to Other Role

Parameters:

• bindings (ContextualAnimSceneBindings) –

• role (Name) –

• relative_to_role (Name) –

• time (float) –

Return type:

Transform

classmethod bp_scene_bindings_get_alignment_transform_for_role_relative_to_warp_point(bindings, role, warp_point, time) → Transform

BP Scene Bindings Get Alignment Transform for Role Relative to Warp Point

Parameters:

• bindings (ContextualAnimSceneBindings) –

• role (Name) –

• warp_point (ContextualAnimWarpPoint) –

• time (float) –

Return type:

Transform

classmethod bp_scene_bindings_get_alignment_transform_from_binding(bindings, binding, warp_point) → Transform

BP Scene Bindings Get Alignment Transform from Binding

Parameters:

• bindings (ContextualAnimSceneBindings) –

• binding (ContextualAnimSceneBinding) –

• warp_point (ContextualAnimWarpPoint) –

Return type:

Transform

classmethod bp_scene_bindings_get_binding_by_actor(bindings, actor) → ContextualAnimSceneBinding

BP Scene Bindings Get Binding by Actor

Parameters:

• bindings (ContextualAnimSceneBindings) –

• actor (Actor) –

Return type:

ContextualAnimSceneBinding

classmethod bp_scene_bindings_get_binding_by_role(bindings, role) → ContextualAnimSceneBinding

BP Scene Bindings Get Binding by Role

Parameters:

• bindings (ContextualAnimSceneBindings) –

• role (Name) –

Return type:

ContextualAnimSceneBinding

classmethod bp_scene_bindings_get_bindings(bindings) → Array[ContextualAnimSceneBinding]

BP Scene Bindings Get Bindings

Parameters:

bindings (ContextualAnimSceneBindings) –

Return type:

Array[ContextualAnimSceneBinding]

classmethod bp_scene_bindings_get_scene_asset(bindings) → ContextualAnimSceneAsset

BP Scene Bindings Get Scene Asset

Parameters:

bindings (ContextualAnimSceneBindings) –

Return type:

ContextualAnimSceneAsset

classmethod bp_scene_bindings_get_section_and_anim_set_indices(bindings) -> (section_idx=int32, anim_set_idx=int32)

BP Scene Bindings Get Section and Anim Set Indices

Parameters:

bindings (ContextualAnimSceneBindings) –

Returns:

section_idx (int32):

anim_set_idx (int32):

Return type:

tuple