unreal.MovieSceneSequenceExtensions

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

Bases: unreal.BlueprintFunctionLibrary

Function library containing methods that should be hoisted onto UMovieSceneSequences for scripting purposes

C++ Source:

  • Plugin: SequencerScripting
  • Module: SequencerScripting
  • File: MovieSceneSequenceExtensions.h
classmethod add_marked_frame(sequence, marked_frame) → None
  • Add a given user marked frame.
  • A unique label will be generated if the marked frame label is empty

The given user marked frame to add:

Parameters:
classmethod add_master_track(sequence, track_type) → MovieSceneTrack

Add a new master track of the specified type

Parameters:
Returns:

The newly created track, if successful

Return type:

MovieSceneTrack

classmethod add_possessable(sequence, object_to_possess) → SequencerBindingProxy

Add a new binding to this sequence that will possess the specified object

Parameters:
  • sequence (MovieSceneSequence) – The sequence to add a possessable to
  • object_to_possess (Object) – The object that this sequence should possess when evaluating
Returns:

A unique identifier for the new binding

Return type:

SequencerBindingProxy

classmethod add_root_folder_to_sequence(sequence, new_folder_name) → MovieSceneFolder

Add a root folder to the given sequence

Parameters:
  • sequence (MovieSceneSequence) – The sequence to add a folder to
  • new_folder_name (str) – The name to give the added folder
Returns:

The newly created folder

Return type:

MovieSceneFolder

classmethod add_spawnable_from_class(sequence, class_to_spawn) → SequencerBindingProxy

Add a new binding to this sequence that will spawn the specified object

Parameters:
  • sequence (MovieSceneSequence) – The sequence to add to
  • class_to_spawn (type(Class)) – A class or blueprint type to spawn for this binding
Returns:

A unique identifier for the new binding

Return type:

SequencerBindingProxy

classmethod add_spawnable_from_instance(sequence, object_to_spawn) → SequencerBindingProxy

Add a new binding to this sequence that will spawn the specified object

Parameters:
  • sequence (MovieSceneSequence) – The sequence to add to
  • object_to_spawn (Object) – An object instance to use as a template for spawning
Returns:

A unique identifier for the new binding

Return type:

SequencerBindingProxy

classmethod clear_marked_frames(sequence) → None
  • Clear all user marked frames
Parameters:sequence (MovieSceneSequence) –
classmethod find_binding_by_name(sequence, name) → SequencerBindingProxy

Attempt to locate a binding in this sequence by its name

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to find the binding
  • name (str) – The display name of the binding to look up
Returns:

A unique identifier for the binding, or invalid

Return type:

SequencerBindingProxy

classmethod find_marked_frame_by_frame_number(sequence, frame_number) → int32
  • Find the user marked frame by frame number

The frame number of the user marked frame to find:

Parameters:
Returns:

Return type:

int32

classmethod find_marked_frame_by_label(sequence, label) → int32
  • Find the user marked frame by label

The label to the user marked frame to find:

Parameters:
Returns:

Return type:

int32

classmethod find_master_tracks_by_exact_type(sequence, track_type) -> Array(MovieSceneTrack)

Find all master tracks of the specified type, not allowing sub-classed types

Parameters:
  • sequence (MovieSceneSequence) – The sequence to use
  • track_type (type(Class)) – A UMovieSceneTrack class type specifying the exact types of track to return
Returns:

An array containing any tracks that are exactly the same as the type specified

Return type:

Array(MovieSceneTrack)

classmethod find_master_tracks_by_type(sequence, track_type) -> Array(MovieSceneTrack)

Find all master tracks of the specified type

Parameters:
  • sequence (MovieSceneSequence) – The sequence to use
  • track_type (type(Class)) – A UMovieSceneTrack class type specifying which types of track to return
Returns:

An array containing any tracks that match the type specified

Return type:

Array(MovieSceneTrack)

classmethod find_next_marked_frame(sequence, frame_number, forward) → int32
  • Find the next/previous user marked frame from the given frame number

The frame number to find the next/previous user marked frame from *: Find forward from the given frame number.:

Parameters:
Returns:

Return type:

int32

classmethod get_bindings(sequence) -> Array(SequencerBindingProxy)

Get all the bindings in this sequence

Parameters:sequence (MovieSceneSequence) – The sequence to get bindings for
Returns:An array of unique identifiers for all the bindings in this sequence
Return type:Array(SequencerBindingProxy)
classmethod get_display_rate(sequence) → FrameRate

Gets this sequence’s display rate

Parameters:sequence (MovieSceneSequence) – The sequence to use
Returns:The display rate that this sequence is displayed as
Return type:FrameRate
classmethod get_marked_frames(sequence) -> Array(MovieSceneMarkedFrame)
Parameters:sequence (MovieSceneSequence) –
Returns:Return the user marked frames
Return type:Array(MovieSceneMarkedFrame)
classmethod get_master_tracks(sequence) -> Array(MovieSceneTrack)

Get all master tracks

Parameters:sequence (MovieSceneSequence) – The sequence to use
Returns:An array containing all master tracks in this sequence
Return type:Array(MovieSceneTrack)
classmethod get_movie_scene(sequence) → MovieScene

Get this sequence’s movie scene data

Parameters:sequence (MovieSceneSequence) – The sequence to use
Returns:This sequence’s movie scene data object
Return type:MovieScene
classmethod get_playback_end(sequence) → int32

Get playback end of this sequence

Parameters:sequence (MovieSceneSequence) – The sequence within which to get the playback end
Returns:Playback end of this sequence
Return type:int32
classmethod get_playback_end_seconds(sequence) → float

Get playback end of this sequence in seconds

Parameters:sequence (MovieSceneSequence) – The sequence within which to get the playback end
Returns:Playback end of this sequence
Return type:float
classmethod get_playback_start(sequence) → int32

Get playback start of this sequence

Parameters:sequence (MovieSceneSequence) – The sequence within which to get the playback start
Returns:Playback start of this sequence
Return type:int32
classmethod get_playback_start_seconds(sequence) → float

Get playback start of this sequence in seconds

Parameters:sequence (MovieSceneSequence) – The sequence within which to get the playback start
Returns:Playback start of this sequence
Return type:float
classmethod get_possessables(sequence) -> Array(SequencerBindingProxy)

Get all the possessables in this sequence

Parameters:sequence (MovieSceneSequence) – The sequence to get possessables for
Returns:Possessables in this sequence
Return type:Array(SequencerBindingProxy)
classmethod get_root_folders_in_sequence(sequence) -> Array(MovieSceneFolder)

Get the root folders in the provided sequence

Parameters:sequence (MovieSceneSequence) – The sequence to retrieve folders from
Returns:The folders contained within the given sequence
Return type:Array(MovieSceneFolder)
classmethod get_spawnables(sequence) -> Array(SequencerBindingProxy)

Get all the spawnables in this sequence

Parameters:sequence (MovieSceneSequence) – The sequence to get spawnables for
Returns:Spawnables in this sequence
Return type:Array(SequencerBindingProxy)
classmethod get_tick_resolution(sequence) → FrameRate

Gets this sequence’s tick resolution

Parameters:sequence (MovieSceneSequence) – The sequence to use
Returns:The tick resolution of the sequence, defining the smallest unit of time representable on this sequence
Return type:FrameRate
classmethod get_timecode_source(sequence) → Timecode

Get the timecode source of this sequence

Parameters:sequence (MovieSceneSequence) – The sequence within which to get the timecode source
Returns:Timecode source of this sequence
Return type:Timecode
classmethod get_view_range_end(sequence) → float

Get the sequence view range end in seconds

Parameters:sequence (MovieSceneSequence) –
Returns:The view range end time in seconds for this sequence
Return type:float
classmethod get_view_range_start(sequence) → float

Get the sequence view range start in seconds

Parameters:sequence (MovieSceneSequence) –
Returns:The view range start time in seconds for this sequence
Return type:float
classmethod get_work_range_end(sequence) → float

Get the sequence work range end in seconds

Parameters:sequence (MovieSceneSequence) –
Returns:The work range end time in seconds for this sequence
Return type:float
classmethod get_work_range_start(sequence) → float

Get the sequence work range start in seconds

Parameters:sequence (MovieSceneSequence) –
Returns:The work range start time in seconds for this sequence
Return type:float
classmethod locate_bound_objects(sequence, binding, context) -> Array(Object)

Locate all the objects that correspond to the specified object ID, using the specified context

Parameters:
Returns:

An array of all bound objects

Return type:

Array(Object)

classmethod make_range(sequence, start_frame, duration) → SequencerScriptingRange

Make a new range for this sequence in its display rate

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to find the binding
  • start_frame (int32) – The frame at which to start the range
  • duration (int32) – The length of the range
Returns:

Specified sequencer range

Return type:

SequencerScriptingRange

classmethod make_range_seconds(sequence, start_time, duration) → SequencerScriptingRange

Make a new range for this sequence in seconds

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to find the binding
  • start_time (float) – The time in seconds at which to start the range
  • duration (float) – The length of the range in seconds
Returns:

Specified sequencer range

Return type:

SequencerScriptingRange

classmethod remove_marked_frame(sequence, remove_index) → None
  • Remove the user marked frame by index.

The index to the user marked frame to remove:

Parameters:
classmethod set_display_rate(sequence, display_rate) → None

Sets this sequence’s display rate

Parameters:
  • sequence (MovieSceneSequence) – The sequence to use
  • display_rate (FrameRate) – The display rate that this sequence is displayed as
classmethod set_playback_end(sequence, end_frame) → None

Set playback end of this sequence

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to set the playback end
  • end_frame (int32) – The desired end frame for this sequence
classmethod set_playback_end_seconds(sequence, end_time) → None

Set playback end of this sequence in seconds

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to set the playback end
  • end_time (float) – The desired end time in seconds for this sequence
classmethod set_playback_start(sequence, start_frame) → None

Set playback start of this sequence

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to set the playback start
  • start_frame (int32) – The desired start frame for this sequence
classmethod set_playback_start_seconds(sequence, start_time) → None

Set playback start of this sequence in seconds

Parameters:
  • sequence (MovieSceneSequence) – The sequence within which to set the playback start
  • start_time (float) – The desired start time in seconds for this sequence
classmethod set_tick_resolution(sequence, tick_resolution) → None

Sets this sequence’s tick resolution

Parameters:
  • sequence (MovieSceneSequence) – The sequence to use
  • tick_resolution (FrameRate) – The tick resolution of the sequence, defining the smallest unit of time representable on this sequence
classmethod set_view_range_end(sequence, end_time_in_seconds) → None

Set the sequence view range end in seconds

Parameters:
classmethod set_view_range_start(sequence, start_time_in_seconds) → None

Set the sequence view range start in seconds

Parameters:
  • sequence (MovieSceneSequence) –
  • start_time_in_seconds (float) – The desired view range start time in seconds for this sequence
classmethod set_work_range_end(sequence, end_time_in_seconds) → None

Set the sequence work range end in seconds

Parameters:
classmethod set_work_range_start(sequence, start_time_in_seconds) → None

Set the sequence work range start in seconds

Parameters:
  • sequence (MovieSceneSequence) –
  • start_time_in_seconds (float) – The desired work range start time in seconds for this sequence