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) → int32¶ 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
sequence (MovieSceneSequence) –
marked_frame (MovieSceneMarkedFrame) –
- Returns
The index to the newly added marked frame
- Return type
int32
-
classmethod
add_master_track
(sequence, track_type) → MovieSceneTrack¶ Add a new master track of the specified type
- Parameters
sequence (MovieSceneSequence) – The sequence to use
track_type (type(Class)) – A UMovieSceneTrack class type to create
- Returns
The newly created track, if successful
- Return type
-
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
-
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
-
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
-
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
-
classmethod
delete_marked_frame
(sequence, delete_index) → None¶ Delete the user marked frame by index.
The index to the user marked frame to delete:
- Parameters
sequence (MovieSceneSequence) –
delete_index (int32) –
-
classmethod
delete_marked_frames
(sequence) → None¶ Delete all user marked frames
- Parameters
sequence (MovieSceneSequence) –
-
classmethod
find_binding_by_id
(sequence, binding_id) → SequencerBindingProxy¶ Attempt to locate a binding in this sequence by its Id
- Parameters
sequence (MovieSceneSequence) – The sequence within which to find the binding
binding_id (Guid) – The binding Id to look up
- Returns
A unique identifier for the binding, or invalid
- Return type
-
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
-
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
sequence (MovieSceneSequence) –
frame_number (FrameNumber) –
- 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
sequence (MovieSceneSequence) –
label (str) –
- Returns
- Return type
int32
-
classmethod
find_master_tracks_by_exact_type
(sequence, track_type)¶ 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
-
classmethod
find_master_tracks_by_type
(sequence, track_type)¶ 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
-
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
sequence (MovieSceneSequence) –
frame_number (FrameNumber) –
forward (bool) –
- Returns
- Return type
int32
-
classmethod
get_bindings
(sequence)¶ 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
-
classmethod
get_clock_source
(sequence) → UpdateClockSource¶ Get the clock source for this sequence
- Parameters
sequence (MovieSceneSequence) –
- Returns
The clock source for this sequence
- Return type
-
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
-
classmethod
get_evaluation_type
(sequence) → MovieSceneEvaluationType¶ Get the evaluation type for this sequence
- Parameters
sequence (MovieSceneSequence) –
- Returns
The evaluation type for this sequence
- Return type
-
classmethod
get_marked_frames
(sequence)¶ - Parameters
sequence (MovieSceneSequence) –
- Returns
Return the user marked frames
- Return type
-
classmethod
get_master_tracks
(sequence)¶ Get all master tracks
- Parameters
sequence (MovieSceneSequence) – The sequence to use
- Returns
An array containing all master tracks in this sequence
- Return type
-
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
-
classmethod
get_playback_end
(sequence) → int32¶ Get playback end of this sequence in display rate resolution
- 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
-
classmethod
get_playback_range
(sequence) → SequencerScriptingRange¶ Get playback range of this sequence in display rate resolution
- Parameters
sequence (MovieSceneSequence) – The sequence within which to get the playback range
- Returns
Playback range of this sequence
- Return type
-
classmethod
get_playback_start
(sequence) → int32¶ Get playback start of this sequence in display rate resolution
- 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
-
classmethod
get_possessables
(sequence)¶ Get all the possessables in this sequence
- Parameters
sequence (MovieSceneSequence) – The sequence to get possessables for
- Returns
Possessables in this sequence
- Return type
-
classmethod
get_root_folders_in_sequence
(sequence)¶ 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
-
classmethod
get_spawnables
(sequence)¶ Get all the spawnables in this sequence
- Parameters
sequence (MovieSceneSequence) – The sequence to get spawnables for
- Returns
Spawnables in this sequence
- Return type
-
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
-
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
-
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
-
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
-
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
-
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
-
classmethod
is_read_only
(sequence) → bool¶ Is read only
- Parameters
sequence (MovieSceneSequence) –
- Returns
Whether the movie scene is read only or not
- Return type
-
classmethod
locate_bound_objects
(sequence, binding, context)¶ Locate all the objects that correspond to the specified object ID, using the specified context
- Parameters
sequence (MovieSceneSequence) – The sequence to locate bound objects for
binding (SequencerBindingProxy) – The object binding
context (Object) – Optional context to use to find the required object
- Returns
An array of all bound objects
- Return type
-
classmethod
make_binding_id
(master_sequence, binding, space=MovieSceneObjectBindingSpace.ROOT) → MovieSceneObjectBindingID¶ Make a binding id for the given binding in this sequence
- Parameters
master_sequence (MovieSceneSequence) – The master sequence that contains the sequence
binding (SequencerBindingProxy) –
space (MovieSceneObjectBindingSpace) – The object binding space to resolve from (Root or Local)
- Returns
The new object binding id
- Return type
-
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
-
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
-
classmethod
remove_master_track
(sequence, master_track) → bool¶ Removes a master track
- Parameters
sequence (MovieSceneSequence) – The sequence to use
master_track (MovieSceneTrack) – The master track to remove
- Returns
Whether the master track was successfully removed
- Return type
-
classmethod
resolve_binding_id
(master_sequence, object_binding_id) → SequencerBindingProxy¶ Make a binding for the given binding ID
- Parameters
master_sequence (MovieSceneSequence) – The master sequence that contains the sequence
object_binding_id (MovieSceneObjectBindingID) –
- Returns
The new binding proxy
- Return type
-
classmethod
set_clock_source
(sequence, clock_source) → None¶ Set the clock source for this sequence
- Parameters
sequence (MovieSceneSequence) –
clock_source (UpdateClockSource) – The clock source to set for this sequence
-
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_evaluation_type
(sequence, evaluation_type) → None¶ Set the evaluation type for this sequence
- Parameters
sequence (MovieSceneSequence) –
evaluation_type (MovieSceneEvaluationType) – The evaluation type to set for this sequence
-
classmethod
set_marked_frame
(sequence, mark_index, frame_number) → None¶ Sets the frame number for the given marked frame index. Does not maintain sort. Call SortMarkedFrames
The given user marked frame index to edit *: The frame number to set:
- Parameters
sequence (MovieSceneSequence) –
mark_index (int32) –
frame_number (FrameNumber) –
-
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_read_only
(sequence, read_only) → None¶ Set read only
Whether the movie scene should be read only or not:
- Parameters
sequence (MovieSceneSequence) –
read_only (bool) –
-
classmethod
set_tick_resolution
(sequence, tick_resolution) → None¶ Sets this sequence’s tick resolution and migrates frame times
- 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_tick_resolution_directly
(sequence, tick_resolution) → None¶ Sets this sequence’s tick resolution directly without migrating frame times
- 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
sequence (MovieSceneSequence) –
end_time_in_seconds (float) –
-
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
sequence (MovieSceneSequence) –
end_time_in_seconds (float) –
-
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
-
classmethod
sort_marked_frames
(sequence) → None¶ Sort the marked frames in chronological order
- Parameters
sequence (MovieSceneSequence) –