unreal.MovieSceneTrack

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

Bases: MovieSceneDecorationContainerObject

Base class for a track in a Movie Scene

C++ Source:

  • Module: MovieScene

  • File: MovieSceneTrack.h

Editor Properties: (see get_editor_property/set_editor_property)

  • condition_container (MovieSceneConditionContainer): [Read-Write] Optional dynamic condition for whether this track/any of the sections on this track evaluates at runtime.

  • decorations (MovieSceneDecorationContainer): [Read-Write] Array of decorations for this movie scene

  • display_options (MovieSceneTrackDisplayOptions): [Read-Write] General display options for a given track

  • eval_options (MovieSceneTrackEvalOptions): [Read-Write] General evaluation options for a given track

  • track_tint (Color): [Read-Write] This track’s tint color

add_section() → MovieSceneSection

Add a new section to this track

Returns:

The newly create section if successful

Return type:

MovieSceneSection

clear_track_condition() → None

Remove the track-level condition

clear_track_row_condition(row_index) → None

Remove the condition from a specific track row

Parameters:

row_index (int32)

get_color_tint() → Color

Get the color tint for this track

Returns:

The color tint of the requested track

Return type:

Color

get_display_name() → Text

Get this track’s display name

Returns:

This track’s display name

Return type:

Text

get_section_to_key() → MovieSceneSection

Get the section to key for this track

Returns:

The section to key for the requested track

Return type:

MovieSceneSection

get_sections() → Array[MovieSceneSection]

Access all this track’s sections

Returns:

An array of this track’s sections

Return type:

Array[MovieSceneSection]

get_sorting_order() → int32

Get the sorting order for this track

Returns:

The sorting order of the requested track

Return type:

int32

get_track_condition() → MovieSceneCondition

Get the track-level condition, or nullptr if none is set

Return type:

MovieSceneCondition

get_track_row_condition(row_index) → MovieSceneCondition

Get the condition on a specific track row, or nullptr if none is set

Parameters:

row_index (int32)

Return type:

MovieSceneCondition

get_track_row_display_name(row_index) → Text

Get this track row’s display name

Parameters:

row_index (int32) – The row index for the track

Returns:

This track’s display name

Return type:

Text

remove_section(section) → None

Remove the specified section

Parameters:

section (MovieSceneSection) – The section to remove

set_color_tint(color_tint) → None

Set the color tint for this track

Parameters:

color_tint (Color) – The color tint to set

set_display_name(name) → None

Set this track’s display name

Parameters:

name (Text) – The name for this track

set_section_to_key(section) → None

Set the section to key for this track. When properties for this section are modified externally, this section will receive those modifications and act accordingly (add/update keys). This is especially useful when there are multiple overlapping sections.

Parameters:

section (MovieSceneSection) – The section to key for this track

set_sorting_order(sorting_order) → None

Set the sorting order for this track

Parameters:

sorting_order (int32) – The sorting order to set

set_track_condition(condition_class) → None

Set a track-level condition by creating a new instance of the given class. Pass nullptr to clear the condition.

Parameters:

condition_class (type(Class))

set_track_row_condition(row_index, condition_class) → None

Set a condition on a specific track row by creating a new instance of the given class. Pass nullptr to clear the row condition.

Parameters:

  • row_index (int32)

  • condition_class (type(Class))

set_track_row_display_name(name, row_index) → None

Set this track row’s display name

Parameters:

  • name (Text) – The name for this track

  • row_index (int32) – The row index for the track