unreal.MovieSceneSection

class unreal.MovieSceneSection(outer=None, name='None')

Bases: unreal.MovieSceneSignedObject

Base class for movie scene sections

C++ Source:

• Module: MovieScene

• File: MovieSceneSection.h

Editor Properties: (see get_editor_property/set_editor_property)

• easing (MovieSceneEasingSettings): [Read-Write] Easing

• eval_options (MovieSceneSectionEvalOptions): [Read-Write] Eval Options

• 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)

find_channels_by_type(channel_type)

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_blend_type() → OptionalMovieSceneBlendType

Gets this section’s blend type

Returns

Return type

OptionalMovieSceneBlendType

get_channels()

Find all channels that belong to the specified UMovieSceneSection. Some sections have many channels (such as Transforms containing 9 float 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_completion_mode() → MovieSceneCompletionMode

Gets this section’s completion mode

Returns

Return type

MovieSceneCompletionMode

get_end_frame() → int32

Get end frame

Returns

End frame of this section

Return type

int32

get_end_frame_seconds() → float

Get end time in seconds

Returns

End time of this section

Return type

float

get_overlap_priority() → int32

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

Returns

Return type

int32

get_post_roll_frames() → int32

Get Post Roll Frames

Returns

Return type

int32

get_pre_roll_frames() → int32

Get Pre Roll Frames

Returns

Return type

int32

get_row_index() → int32

Gets the row index for this section

Returns

Return type

int32

get_start_frame() → int32

Get start frame

Returns

Start frame of this section

Return type

int32

get_start_frame_seconds() → float

Get start time in seconds

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

Returns

Return type

bool

is_locked() → bool

Is Locked

Returns

Return type

bool

set_blend_type(blend_type) → None

Sets this section’s blend type

Parameters

blend_type (MovieSceneBlendType) –

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