unreal.MovieSceneSection

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

Bases: MovieSceneSignedObject

Base class for movie scene sections

C++ Source:

• Module: MovieScene

• File: MovieSceneSection.h

Editor Properties: (see get_editor_property/set_editor_property)

• color_tint (Color): [Read-Write] The color tint for this section

• easing (MovieSceneEasingSettings): [Read-Write]

• eval_options (MovieSceneSectionEvalOptions): [Read-Write]

• is_active (bool): [Read-Write] Toggle whether this section is active/inactive

• is_locked (bool): [Read-Write] Toggle whether this section is locked/unlocked

• post_roll_frames (FrameNumber): [Read-Write] The amount of time to continue ‘postrolling’ this section for after evaluation has ended.

• pre_roll_frames (FrameNumber): [Read-Write] The amount of time to prepare this section for evaluation before it actually starts.

• section_range (MovieSceneFrameRange): [Read-Write] The range in which this section is active

• timecode_source (MovieSceneTimecodeSource): [Read-Write] The timecode at which this movie scene section is based (ie. when it was recorded)

get_all_channels() → Array[MovieSceneScriptingChannel]

Find all channels that belong to the specified UMovieSceneSection. Some sections have many channels (such as Transforms containing 9 double channels to represent Translation/Rotation/Scale), and a section may have mixed channel types.

Returns:

An array containing any key channels that match the type specified

Return type:

Array[MovieSceneScriptingChannel]

get_auto_size_end_frame() → int32

Get end frame of the AutoSize. Will throw an exception if section has no end frame, use GetAutoSizeHasEndFrame to check first.

Returns:

The end frame of the AutoSize data.

Return type:

int32

get_auto_size_end_frame_seconds() → float

Get end time of the AutoSize seconds. Will throw an exception if section has no end frame, use GetAutoSizeHasEndFrame to check first.

Returns:

The end frame of the AutoSize data in seconds.

Return type:

float

get_auto_size_has_end_frame() → bool

Checks to see if this section has an AutoSize implementation, and if so, if that implementation has a end frame.

Returns:

Whether this section has a valid autosize range, and a valid end frame

Return type:

bool

get_auto_size_has_start_frame() → bool

Checks to see if this section has an AutoSize implementation, and if so, if that implementation has a start frame.

Returns:

Whether this section has a valid autosize range, and a valid start frame

Return type:

bool

get_auto_size_start_frame() → int32

Get start frame of the AutoSize. Will throw an exception if section has no start frame, use GetAutoSizeHasStartFrame to check first.

Returns:

The start frame of the AutoSize data.

Return type:

int32

get_auto_size_start_frame_seconds() → float

Get start time of the AutoSize in seconds. Will throw an exception if section has no start frame, use GetAutoSizeHasStartFrame to check first.

Returns:

The start frame of the AutoSize data in seconds.

Return type:

float

get_blend_type() → OptionalMovieSceneBlendType

Gets this section’s blend type

Return type:

OptionalMovieSceneBlendType

get_channel(channel_name) → MovieSceneScriptingChannel

Get channel from specified section and channel name

Parameters:

channel_name (Name) – The name of the channel.

Returns:

The channel if it exists

Return type:

MovieSceneScriptingChannel

get_channels_by_type(channel_type) → Array[MovieSceneScriptingChannel]

Find all channels that belong to the specified UMovieSceneSection that match the specific type. This will filter out any children who do not inherit from the specified type for you.

Parameters:

channel_type (type(Class)) – The class type to look for.

Returns:

An array containing any key channels that match the type specified

Return type:

Array[MovieSceneScriptingChannel]

get_color_tint() → Color

Get this section’s color tint.

Return type:

Color

get_completion_mode() → MovieSceneCompletionMode

Gets this section’s completion mode

Return type:

MovieSceneCompletionMode

get_end_frame() → int32

Get end frame. Will throw an exception if section has no end frame, use HasEndFrame to check first.

Returns:

End frame of this section

Return type:

int32

get_end_frame_seconds() → float

Get end time in seconds. Will throw an exception if section has no end frame, use HasEndFrame to check first.

Returns:

End time of this section

Return type:

float

get_overlap_priority() → int32

Gets this section’s priority over overlapping sections (higher wins)

Return type:

int32

get_post_roll_frames() → int32

Get Post Roll Frames

Return type:

int32

get_pre_roll_frames() → int32

Get Pre Roll Frames

Return type:

int32

get_row_index() → int32

Gets the row index for this section

Return type:

int32

get_start_frame() → int32

Get start frame. Will throw an exception if section has no start frame, use HasStartFrame to check first.

Returns:

Start frame of this section

Return type:

int32

get_start_frame_seconds() → float

Get start time in seconds. Will throw an exception if section has no start frame, use HasStartFrame to check first.

Returns:

Start time of this section

Return type:

float

has_end_frame() → bool

Has end frame

Returns:

Whether this section has a valid end frame (else infinite)

Return type:

bool

has_start_frame() → bool

Has start frame

Returns:

Whether this section has a valid start frame (else infinite)

Return type:

bool

is_active() → bool

Is Active

Return type:

bool

is_locked() → bool

Is Locked

Return type:

bool

set_blend_type(blend_type) → None

Sets this section’s blend type

Parameters:

blend_type (MovieSceneBlendType) –

set_color_tint(color_tint) → None

Set this section’s color tint.

Parameters:

color_tint (Color) –

set_completion_mode(completion_mode) → None

• Sets this section’s completion mode

Parameters:

completion_mode (MovieSceneCompletionMode) –

set_end_frame(end_frame) → None

Set end frame

Parameters:

end_frame (int32) – The desired start frame for this section

set_end_frame_bounded(is_bounded) → None

Set end frame bounded

Parameters:

is_bounded (bool) –

set_end_frame_seconds(end_time) → None

Set end time in seconds

Parameters:

end_time (float) – The desired end time for this section

set_is_active(is_active) → None

Whether or not this section is active.

Parameters:

is_active (bool) –

set_is_locked(is_locked) → None

Whether or not this section is locked.

Parameters:

is_locked (bool) –

set_overlap_priority(new_priority) → None

Sets this section’s priority over overlapping sections (higher wins)

Parameters:

new_priority (int32) –

set_post_roll_frames(post_roll_frames) → None

Gets/sets the number of frames to continue ‘postrolling’ this section for after evaluation has ended.

Parameters:

post_roll_frames (int32) –

set_pre_roll_frames(pre_roll_frames) → None

Gets the number of frames to prepare this section for evaluation before it actually starts.

Parameters:

pre_roll_frames (int32) –

set_range(start_frame, end_frame) → None

Set range

Parameters:

• start_frame (int32) – The desired start frame for this section

• end_frame (int32) – The desired end frame for this section

set_range_seconds(start_time, end_time) → None

Set range in seconds

Parameters:

• start_time (float) – The desired start frame for this section

• end_time (float) – The desired end frame for this section

set_row_index(new_row_index) → None

Sets this section’s new row index

Parameters:

new_row_index (int32) –

set_start_frame(start_frame) → None

Set start frame

Parameters:

start_frame (int32) – The desired start frame for this section

set_start_frame_bounded(is_bounded) → None

Set start frame bounded

Parameters:

is_bounded (bool) –

set_start_frame_seconds(start_time) → None

Set start time in seconds

Parameters:

start_time (float) – The desired start time for this section