1. Epic GamesDeveloper
  3. ULevelSequenceEditorSubsystem

ULevelSequenceEditorSubsystem

[ULevelSequenceEditorSubsystem](API\Plugins\LevelSequenceEditor\ULevelSequenceEditorSubsystem) Subsystem for level sequence editor related utilities to scripts

API > API/Plugins > API/Plugins/LevelSequenceEditor

ULevelSequenceEditorSubsystem Subsystem for level sequence editor related utilities to scripts

   
Name ULevelSequenceEditorSubsystem
Type class
Header File /Engine/Plugins/MovieScene/LevelSequenceEditor/Source/LevelSequenceEditor/Public/LevelSequenceEditorSubsystem.h
Include Path #include "LevelSequenceEditorSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class ULevelSequenceEditorSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Structs

Name Remarks
FBindingPropertiesNotifyHook Used by binding properties menu.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AssignActorMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  
BindingPropertiesMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  
BindingPropertyInfoList TObjectPtr< UMovieSceneBindingPropertyInfoList >   LevelSequenceEditorSubsystem.h  
CommandList TSharedPtr< FUICommandList >   LevelSequenceEditorSubsystem.h  
CurveEditorArray TArray< TObjectPtr< USequencerCurveEditorObject > > Property array of the curve editors LevelSequenceEditorSubsystem.h  
CurveEditorObjects TMap< TWeakPtr< ISequencer >, TObjectPtr< USequencerCurveEditorObject > > Map of curve editors with their sequencers LevelSequenceEditorSubsystem.h  
FixActorReferencesMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  
NotifyHook FBindingPropertiesNotifyHook   LevelSequenceEditorSubsystem.h  
OnSequencerCreatedHandle FDelegateHandle   LevelSequenceEditorSubsystem.h  
RebindComponentMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  
Sequencers TArray< TWeakPtr< ISequencer > > List of sequencers that have been created LevelSequenceEditorSubsystem.h  
SidebarMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  
TrackRowMetadataHelperList TArray< TObjectPtr< UMovieSceneTrackRowMetadataHelper > >   LevelSequenceEditorSubsystem.h  
TransformMenuExtender TSharedPtr< FExtender >   LevelSequenceEditorSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Add existing actors to Sequencer. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void AddActorsToBinding ( const TArray< AActor* >& Actors,
const FMovieSceneBindingProxy& ObjectBinding
)

 Assigns the given actors to the binding LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void AddBindingPropertiesSidebar ( FMenuBuilder& MenuBuilder
)

   LevelSequenceEditorSubsystem.h  

void AddChangeBindingTypeMenu ( FMenuBuilder& MenuBuilder,
TSharedRef< ISequencer > Sequencer,
const TArray< FSequencerChangeBindingInfo >& BindingsToChange,
bool bConvert,
TFunction< void()> OnBindingChanged
)

 Creates a menu for changing or converting a binding type. LevelSequenceEditorSubsystem.h  

FMovieSceneBindingProxy AddSpawnableFromClass ( UMovieSceneSequence* Sequence,
UClass* ClassToSpawn
)

 Add a new binding to this sequence that will spawn the specified class. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

FMovieSceneBindingProxy AddSpawnableFromInstance ( UMovieSceneSequence* Sequence,
UObject* ObjectToSpawn
)

 Add a new binding to this sequence that will spawn the specified object. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

bool BakeTransformWithSettings ( const TArray< FMovieSceneBindingProxy >& ObjectBindings,
const FBakingAnimationKeySettings& InSettings,
const FMovieSceneScriptingParams& Params
)

 Bake transform LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

bool ChangeActorTemplateClass ( const FMovieSceneBindingProxy& ObjectBinding,
TSubclassOf< AActor > ActorClass
)

 Sets the actor class for the spawnable or replaceable template, in the case those binding types support templates. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

FMovieSceneBindingProxy ConvertToCustomBinding ( const FMovieSceneBindingProxy& ObjectBinding,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UMovieSceneCustomBinding > BindingType
)

 Convert to a custom binding of the given binding type LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

FMovieSceneBindingProxy ConvertToPossessable ( const FMovieSceneBindingProxy& ObjectBinding
)

 Convert to possessable. If there are multiple objects assigned to the spawnable. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"
Convert to spawnable. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void CopyBindings ( const TArray< FMovieSceneBindingProxy >& Bindings,
FString& ExportedText
)

 Copy bindings The copied bindings will be saved to the clipboard as well as assigned to the ExportedText string. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void CopyFolders ( const TArray< UMovieSceneFolder* >& Folders,
FString& FoldersExportedText
)

   LevelSequenceEditorSubsystem.h  

void CopyFolders ( const TArray< UMovieSceneFolder* >& Folders,
FString& FoldersExportedText,
FString& ObjectsExportedText,
FString& TracksExportedText
)

 Copy folders The copied folders will be saved to the clipboard as well as assigned to the ExportedText string. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void CopySections ( const TArray< UMovieSceneSection* >& Sections,
FString& ExportedText
)

 Copy sections The copied sections will be saved to the clipboard as well as assigned to the ExportedText string. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void CopyTracks ( const TArray< UMovieSceneTrack* >& Tracks,
FString& ExportedText
)

 Copy tracks The copied tracks will be saved to the clipboard as well as assigned to the ExportedText string. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

FMovieSceneBindingProxy CreateCamera ( bool bSpawnable,
ACineCameraActor*& OutActor
)

 Create a cine camera actor and add it to Sequencer LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

virtual void Deinitialize()

   LevelSequenceEditorSubsystem.h  

void FixActorReferences()

 Attempts to automatically fix up broken actor references in the current scene LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

USequencerCurveEditorObject * GetCurveEditor()

 Retrieve the curve editor LevelSequenceEditorSubsystem.h
  • BlueprintPure
  • Category="Level Sequence Editor"

TArray< UMovieSceneCustomBinding * > GetCustomBindingObjects ( const FMovieSceneBindingProxy& ObjectBinding
)

 In the case that the given binding proxy holds custom bindings, returns an array of the binding objects so properties can be accessed. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

TArray< FMovieSceneBindingProxy > GetCustomBindingsOfType ( TSubclassOf< UMovieSceneCustomBinding > CustomBindingType
)

 Returns all of the bindings in the sequence of the given custom type. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

TSubclassOf< UMovieSceneCustomBinding > GetCustomBindingType ( const FMovieSceneBindingProxy& ObjectBinding
)

 Returns the custom binding type for the given binding, or nullptr for possessables LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

USequencerModuleScriptingLayer * GetScriptingLayer()

 Retrieve the scripting layer LevelSequenceEditorSubsystem.h
  • BlueprintPure
  • Category="Level Sequence Editor"

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   LevelSequenceEditorSubsystem.h  

void OnSequencerClosed ( TSharedRef< ISequencer > InSequencer
)

   LevelSequenceEditorSubsystem.h  

void OnSequencerCreated ( TSharedRef< ISequencer > InSequencer
)

   LevelSequenceEditorSubsystem.h  

bool PasteBindings ( const FString& TextToImport,
FMovieScenePasteBindingsParams PasteBindingsParams,
TArray< FMovieSceneBindingProxy >& OutObjectBindings
)

 Paste bindings Paste bindings from the given TextToImport string (used in conjunction with CopyBindings). LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

bool PasteFolders ( const FString& TextToImport,
FMovieScenePasteFoldersParams PasteFoldersParams,
TArray< UMovieSceneFolder* >& OutFolders
)

 Paste folders Paste folders from the given TextToImport string (used in conjunction with CopyFolders). LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

bool PasteSections ( const FString& TextToImport,
FMovieScenePasteSectionsParams PasteSectionsParams,
TArray< UMovieSceneSection* >& OutSections
)

 Paste sections Paste sections from the given TextToImport string (used in conjunction with CopySections). LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

bool PasteTracks ( const FString& TextToImport,
FMovieScenePasteTracksParams PasteTracksParams,
TArray< UMovieSceneTrack* >& OutTracks
)

 Paste tracks Paste tracks from the given TextToImport string (used in conjunction with CopyTracks). LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void RebindComponent ( const TArray< FMovieSceneBindingProxy >& ComponentBindings,
const FName& ComponentName
)

 Rebind the component binding to the requested component LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void RefreshBindingDetails ( IDetailsView* DetailsView,
FGuid ObjectBindingID
)

 Refreshes the binding details when the bindings change in the menu. LevelSequenceEditorSubsystem.h  

void RefreshTrackRowMetadataDetails ( IDetailsView* DetailsView
)

 Refreshes the track row metadata details when the track row metadata changes in the menu. LevelSequenceEditorSubsystem.h  

void RemoveActorsFromBinding ( const TArray< AActor* >& Actors,
const FMovieSceneBindingProxy& ObjectBinding
)

 Removes the given actors from the binding LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void RemoveAllBindings ( const FMovieSceneBindingProxy& ObjectBinding
)

 Remove all bound actors from this track LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void RemoveInvalidBindings ( const FMovieSceneBindingProxy& ObjectBinding
)

 Remove missing objects bound to this track LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void ReplaceBindingWithActors ( const TArray< AActor* >& Actors,
const FMovieSceneBindingProxy& ObjectBinding
)

 Replaces the binding with the given actors LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void SaveDefaultSpawnableState ( const FMovieSceneBindingProxy& ObjectBinding
)

 Save the default state of the spawnable. LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void SnapSectionsToTimelineUsingSourceTimecode ( const TArray< UMovieSceneSection* >& Sections
)

 Snap sections to timeline using source timecode LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

void SyncSectionsUsingSourceTimecode ( const TArray< UMovieSceneSection* >& Sections
)

 Sync section using source timecode LevelSequenceEditorSubsystem.h
  • BlueprintCallable
  • Category="Level Sequence Editor"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page