unreal.LevelSequenceEditorSubsystem

class unreal.LevelSequenceEditorSubsystem(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: EditorSubsystem

ULevelSequenceEditorSubsystem Subsystem for level sequencer related utilities to scripts

C++ Source:

  • Plugin: LevelSequenceEditor

  • Module: LevelSequenceEditor

  • File: LevelSequenceEditorSubsystem.h

add_actors(actors) → Array[MovieSceneBindingProxy]

Add existing actors to Sequencer. Tracks will be automatically added based on default track settings.

Parameters:

actors (Array[Actor]) –

Return type:

Array[MovieSceneBindingProxy]

add_actors_to_binding(actors, object_binding) → None

Assigns the given actors to the binding

Parameters:
bake_transform(object_bindings, bake_in_time, bake_out_time, bake_interval, params=[SequenceTimeUnit.DISPLAY_RATE]) → None

Bake transform

Parameters:
convert_to_possessable(object_binding) → MovieSceneBindingProxy

Convert to possessable

Parameters:

object_binding (MovieSceneBindingProxy) –

Return type:

MovieSceneBindingProxy

convert_to_spawnable(object_binding) → Array[MovieSceneBindingProxy]

Convert to spawnable. If there are multiple objects assigned to the possessable, multiple spawnables will be created.

Parameters:

object_binding (MovieSceneBindingProxy) –

Return type:

Array[MovieSceneBindingProxy]

copy_bindings(bindings) → str

Copy bindings The copied bindings will be saved to the clipboard as well as assigned to the ExportedText string. The ExportedTest string can be used in conjunction with PasteBindings if, for example, pasting copy/pasting multiple bindings without relying on a single clipboard.

Parameters:

bindings (Array[MovieSceneBindingProxy]) –

Returns:

exported_text (str):

Return type:

str

copy_folders(folders) → str

Copy folders The copied folders will be saved to the clipboard as well as assigned to the ExportedText string. The ExportedTest string can be used in conjunction with PasteFolders if, for example, pasting copy/pasting multiple folders without relying on a single clipboard.

Parameters:

folders (Array[MovieSceneFolder]) –

Returns:

exported_text (str):

Return type:

str

copy_sections(sections) → str

Copy sections The copied sections will be saved to the clipboard as well as assigned to the ExportedText string. The ExportedTest string can be used in conjunction with PasteSections if, for example, pasting copy/pasting multiple sections without relying on a single clipboard.

Parameters:

sections (Array[MovieSceneSection]) –

Returns:

exported_text (str):

Return type:

str

copy_tracks(tracks) → str

Copy tracks The copied tracks will be saved to the clipboard as well as assigned to the ExportedText string. The ExportedTest string can be used in conjunction with PasteTracks if, for example, pasting copy/pasting multiple tracks without relying on a single clipboard.

Parameters:

tracks (Array[MovieSceneTrack]) –

Returns:

exported_text (str):

Return type:

str

create_camera(spawnable) -> (MovieSceneBindingProxy, out_actor=CineCameraActor)

Create a cine camera actor and add it to Sequencer

Parameters:

spawnable (bool) –

Returns:

out_actor (CineCameraActor):

Return type:

CineCameraActor

fix_actor_references() → None

Attempts to automatically fix up broken actor references in the current scene

paste_bindings(text_to_import, paste_bindings_params) → Array[MovieSceneBindingProxy] or None

Paste bindings Paste bindings from the given TextToImport string (used in conjunction with CopyBindings). If TextToImport is empty, the contents of the clipboard will be used.

Parameters:
Returns:

out_object_bindings (Array[MovieSceneBindingProxy]):

Return type:

Array[MovieSceneBindingProxy] or None

paste_folders(text_to_import, paste_folders_params) → Array[MovieSceneFolder] or None

Paste folders Paste folders from the given TextToImport string (used in conjunction with CopyFolders). If TextToImport is empty, the contents of the clipboard will be used.

Parameters:
Returns:

out_folders (Array[MovieSceneFolder]):

Return type:

Array[MovieSceneFolder] or None

paste_sections(text_to_import, paste_sections_params) → Array[MovieSceneSection] or None

Paste sections Paste sections from the given TextToImport string (used in conjunction with CopySections). If TextToImport is empty, the contents of the clipboard will be used.

Parameters:
Returns:

out_sections (Array[MovieSceneSection]):

Return type:

Array[MovieSceneSection] or None

paste_tracks(text_to_import, paste_tracks_params) → Array[MovieSceneTrack] or None

Paste tracks Paste tracks from the given TextToImport string (used in conjunction with CopyTracks). If TextToImport is empty, the contents of the clipboard will be used.

Parameters:
Returns:

out_tracks (Array[MovieSceneTrack]):

Return type:

Array[MovieSceneTrack] or None

rebind_component(component_bindings, component_name) → None

Rebind the component binding to the requested component

Parameters:
remove_actors_from_binding(actors, object_binding) → None

Removes the given actors from the binding

Parameters:
remove_all_bindings(object_binding) → None

Remove all bound actors from this track

Parameters:

object_binding (MovieSceneBindingProxy) –

remove_invalid_bindings(object_binding) → None

Remove missing objects bound to this track

Parameters:

object_binding (MovieSceneBindingProxy) –

replace_binding_with_actors(actors, object_binding) → None

Replaces the binding with the given actors

Parameters:
snap_sections_to_timeline_using_source_timecode(sections) → None

Snap sections to timeline using source timecode

Parameters:

sections (Array[MovieSceneSection]) –

sync_sections_using_source_timecode(sections) → None

Sync section using source timecode

Parameters:

sections (Array[MovieSceneSection]) –