`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_add_contextual_animation_override_provider(bindings, override_provider) -> (bindings=ContextualAnimSceneBindings, override_provider=ContextualAnimOverrideInterface, out_bindings=ContextualAnimSceneBindings)¶

Add Override Provider to Bindings

Parameters:

bindings (ContextualAnimSceneBindings)
override_provider (ContextualAnimOverrideInterface)

Returns:

bindings (ContextualAnimSceneBindings):

override_provider (ContextualAnimOverrideInterface):

out_bindings (ContextualAnimSceneBindings):

Return type:

tuple

classmethod bp_create_contextual_anim_scene_bindings(scene_asset, params) → ContextualAnimSceneBindings or None¶

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¶

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¶

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¶

GetSectionLength

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¶

GetSectionTimeLeftFromPos

Parameters:

montage (AnimMontage)
position (float)

Return type:

float

classmethod bp_scene_binding_context_get_actor(binding_context) → Actor¶

Get Actor

Parameters:: binding_context (ContextualAnimSceneBindingContext)
Return type:: Actor

classmethod bp_scene_binding_context_get_current_section_and_anim_set_names(binding_context) -> (section_name=Name, anim_set_name=Name)¶

Get Current Section and Anim Set

Parameters:

binding_context (ContextualAnimSceneBindingContext)

Returns:

section_name (Name):

anim_set_name (Name):

Return type:

tuple

classmethod bp_scene_binding_context_get_gameplay_tags(binding_context) → GameplayTagContainer¶

Get GameplayTags

Parameters:: binding_context (ContextualAnimSceneBindingContext)
Return type:: GameplayTagContainer

classmethod bp_scene_binding_context_get_transform(binding_context) → Transform¶

Get Transform

Parameters:: binding_context (ContextualAnimSceneBindingContext)
Return type:: Transform

classmethod bp_scene_binding_context_get_velocity(binding_context) → Vector¶

Get Velocity

Parameters:: binding_context (ContextualAnimSceneBindingContext)
Return type:: Vector

classmethod bp_scene_binding_context_has_all_matching_gameplay_tags(binding_context, tag_container) → bool¶

Has All Matching GameplayTags

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¶

Has Any Matching GameplayTags

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¶

Has Matching GameplayTag

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¶

Make Contextual Anim Scene Binding Context 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¶

Get Animation From Binding

Parameters:

bindings (ContextualAnimSceneBindings)
binding (ContextualAnimSceneBinding)

Return type:

AnimSequenceBase

classmethod bp_scene_binding_get_role_from_binding(bindings, binding) → Name¶

Get Role From Binding

Parameters:

bindings (ContextualAnimSceneBindings)
binding (ContextualAnimSceneBinding)

Return type:

Name

classmethod bp_scene_binding_get_section_and_anim_set_indices(binding) -> (section_idx=int32, anim_set_idx=int32)¶

Get Section And AnimSet Indices

Parameters:

binding (ContextualAnimSceneBinding)

Returns:

section_idx (int32):

anim_set_idx (int32):

Return type:

tuple

classmethod bp_scene_binding_get_skeletal_mesh(binding) → SkeletalMeshComponent¶

Get Skeletal Mesh

Parameters:: binding (ContextualAnimSceneBinding)
Return type:: SkeletalMeshComponent

classmethod bp_scene_bindings_add_or_update_warp_targets_for_bindings(bindings) → None¶

Add Or Update Warp Targets For Bindings

Parameters:: bindings (ContextualAnimSceneBindings)

classmethod bp_scene_bindings_add_or_update_warp_targets_for_section_at_index(bindings, section_idx) → None¶

Add Or Update Warp Targets For Bindings

Parameters:

bindings (ContextualAnimSceneBindings)
section_idx (int32)

classmethod bp_scene_bindings_calculate_warp_points(bindings) → Array[ContextualAnimWarpPoint]¶

Calculate Warp Points For Bindings

Parameters:: bindings (ContextualAnimSceneBindings)
Returns:: out_warp_points (Array[ContextualAnimWarpPoint]):
Return type:: Array[ContextualAnimWarpPoint]

classmethod bp_scene_bindings_calculate_warp_points_for_section_at_index(bindings, section_idx) → Array[ContextualAnimWarpPoint]¶

Calculate Warp Points For Bindings

Parameters:

bindings (ContextualAnimSceneBindings)
section_idx (int32)

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¶