unreal.ContextualAnimSceneAsset
¶
- class unreal.ContextualAnimSceneAsset(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
DataAsset
Contextual Anim Scene Asset
C++ Source:
Plugin: ContextualAnimation
Module: ContextualAnimation
File: ContextualAnimSceneAsset.h
Editor Properties: (see get_editor_property/set_editor_property)
attachment_params
(Array[ContextualAnimAttachmentParams]): [Read-Write]collision_behavior
(ContextualAnimCollisionBehavior): [Read-Write]collision_channels_to_ignore_params
(Array[ContextualAnimIgnoreChannelsParam]): [Read-Write]override_preview_data
(Array[ContextualAnimActorPreviewData]): [Read-Write]precompute_alignment_tracks
(bool): [Read-Write] Whether we should extract and cache alignment tracks off line.primary_role
(Name): [Read-Write]radius
(float): [Read-Write]roles_asset
(ContextualAnimRolesAsset): [Read-Write]sample_rate
(int32): [Read-Write] Sample rate (frames per second) used when sampling the animations to generate alignment and IK trackssections
(Array[ContextualAnimSceneSection]): [Read-Write]
- bp_find_anim_set_index_by_animation(section_idx, animation) int32 ¶
BP Find Anim Set Index by Animation
- Parameters:
section_idx (int32) –
animation (AnimSequenceBase) –
- Return type:
int32
- bp_find_animation_for_role(section_idx, anim_set_idx, role) AnimSequenceBase ¶
Blueprint Interface
- Parameters:
section_idx (int32) –
anim_set_idx (int32) –
role (Name) –
- Return type:
- bp_get_alignment_transform_for_role_relative_to_warp_point(section_idx, anim_set_idx, role, time) Transform ¶
BP Get Alignment Transform for Role Relative to Warp Point
- bp_get_ik_target_transform_for_role_at_time(section_idx, anim_set_idx, role, track_name, time) Transform ¶
BP Get IKTarget Transform for Role at Time
- bp_get_start_and_end_time_for_warp_section(section_idx, anim_set_idx, role, warp_section_name) -> (out_start_time=float, out_end_time=float)¶
BP Get Start and End Time for Warp Section
- get_alignment_points_for_secondary_role(type, section_idx, primary) Array[ContextualAnimPoint] ¶
Get Alignment Points for Secondary Role
- Parameters:
type (ContextualAnimPointType) –
section_idx (int32) –
primary (ContextualAnimSceneBindingContext) –
- Returns:
out_result (Array[ContextualAnimPoint]):
- Return type:
- get_alignment_points_for_secondary_role_considering_selection_criteria(type, section_idx, primary, querier, criterion_to_consider) Array[ContextualAnimPoint] ¶
Get Alignment Points for Secondary Role Considering Selection Criteria
- Parameters:
type (ContextualAnimPointType) –
section_idx (int32) –
primary (ContextualAnimSceneBindingContext) –
querier (ContextualAnimSceneBindingContext) –
criterion_to_consider (ContextualAnimCriterionToConsider) –
- Returns:
out_result (Array[ContextualAnimPoint]):
- Return type:
- query(role, query_params, to_world_transform) ContextualAnimQueryResult or None ¶
TODO:: Kept around only to do not break existing content. It will go away in the future.
- Parameters:
role (Name) –
query_params (ContextualAnimQueryParams) –
to_world_transform (Transform) –
- Returns:
out_result (ContextualAnimQueryResult):
- Return type:
ContextualAnimQueryResult or None