unreal.AnimSequenceTransformProviderDataInstance

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

Bases: AnimSequenceTransformProviderData

Anim Sequence Transform Provider Data Instance

C++ Source:

  • Module: Engine

  • File: AnimSequenceTransformProviderData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blend_space_list (AnimSequenceTransformProviderBlendSpaceList): [Read-Write]

  • blend_spaces (Array[AnimSequenceTransformProviderBlendSpace]): [Read-Write]

  • enable_blend_tracking (bool): [Read-Write] Enable game-thread playback tracking for blend state queries via GetPosition.

  • layer_stack (AnimSequenceTransformProviderLayerStack): [Read-Write]

  • layers (Array[AnimSequenceTransformProviderLayer]): [Read-Write]

  • sequence_list (AnimSequenceTransformProviderSequenceList): [Read-Write]

  • sequences (Array[AnimSequenceTransformProviderSequence]): [Read-Write]

  • skinned_asset (SkinnedAsset): [Read-Write]

allocate_track() → int32

Allocates a track slot across all layer pools with no animation data.

Return type:

int32

classmethod create_anim_sequence_transform_provider_data_instance(provider_data, owner) → AnimSequenceTransformProviderDataInstance

Creates an instance from a provider data asset.

Parameters:
Return type:

AnimSequenceTransformProviderDataInstance

deallocate_track(track_index) → bool

Deallocates a track across all layer pools.

Parameters:

track_index (int32)

Return type:

bool

get_blend_space_position(track_index, layer_index) → Vector2f

Returns the 2D blend space position for a track layer, or zero if not in blend space mode.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

Vector2f

get_layer_weight(track_index, layer_index) → float

Returns the per-track weight for a layer, or 1.0 if invalid.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

float

get_loop_mode(track_index, layer_index) → AnimSequenceTrackLoopMode

Returns the loop mode for a track layer.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

AnimSequenceTrackLoopMode

get_play_rate(track_index, layer_index) → float

Returns the play rate for a track layer, or 0.0 for manual mode, or 1.0 if invalid.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

float

get_position(track_index, layer_index) → AnimSequenceTrackPosition

Returns the current playback position state for a track layer. Source/target blend info requires bEnableBlendTracking.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

AnimSequenceTrackPosition

get_sequence_index(track_index, layer_index) → int32

Returns the sequence index for a track layer. Returns INDEX_NONE for blend space mode.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

int32

get_track_mode(track_index, layer_index) → AnimSequenceTrackMode

Returns the current playback mode for a track layer.

Parameters:

  • track_index (int32)

  • layer_index (int32)

Return type:

AnimSequenceTrackMode

set_auto_play_data(track_index, layer_index, data) → bool

Sets auto play animation data on a track layer.

Parameters:
Return type:

bool

set_blend_space_data(track_index, layer_index, data) → bool

Sets the blend space data for a track layer. The blend space index must reference a valid entry in the BlendSpaces array.

Parameters:
Return type:

bool

set_blend_space_position(track_index, layer_index, position) → bool

Updates the blend space 2D position on a track layer without resetting the animation.

Parameters:

  • track_index (int32)

  • layer_index (int32)

  • position (Vector2f)

Return type:

bool

set_layer_weight(track_index, layer_index, weight) → None

Sets the per-track weight for a layer. Multiplied with the asset’s layer weight.

Parameters:

  • track_index (int32)

  • layer_index (int32)

  • weight (float)

set_loop_mode(track_index, layer_index, loop_mode) → bool

Sets the loop mode on a track layer.

Parameters:
Return type:

bool

set_manual_data(track_index, layer_index, data) → bool

Sets manual animation data on a track layer.

Parameters:
Return type:

bool

set_manual_position(track_index, layer_index, position) → bool

Updates the manual position on a track layer without resetting the animation.

Parameters:

  • track_index (int32)

  • layer_index (int32)

  • position (float)

Return type:

bool

set_play_rate(track_index, layer_index, play_rate) → bool

Sets the play rate on a track layer. Works for auto-play and blend space modes.

Parameters:

  • track_index (int32)

  • layer_index (int32)

  • play_rate (float)

Return type:

bool