1. Epic GamesDeveloper
  3. USequencerToolsFunctionLibrary

USequencerToolsFunctionLibrary

This is a set of helper functions to access various parts of the Sequencer API via Python.

API > API/Plugins > API/Plugins/SequencerScriptingEditor

This is a set of helper functions to access various parts of the Sequencer API via Python. Because Sequencer itself is not suitable for exposing, most functionality gets wrapped by UObjects that have an easier API to work with. This UObject provides access to these wrapper UObjects where needed.

   
Name USequencerToolsFunctionLibrary
Type class
Header File /Engine/Plugins/MovieScene/SequencerScripting/Source/SequencerScriptingEditor/Public/SequencerTools.h
Include Path #include "SequencerTools.h"

Syntax

UCLASS (MinimalAPI, Transient, Meta=(ScriptName="SequencerTools"))  
class USequencerToolsFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void CancelMovieRender()

 Attempts to cancel an in-progress Render to Movie. Does nothing if there is no render in progress. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Movie Rendering"
  • Meta=(DeprecatedFunction)

static void ClearLinkedAnimSequences ( ULevelSequence* InLevelSequence
)

 Clear all linked anim sequences between this level sequence and any linked anim sequences SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static FMovieSceneEvent CreateEvent ( UMovieSceneSequence* InSequence,
UMovieSceneEventSectionBase* InSection,
const FSequencerQuickBindingResult& InEndpoint,
const TArray< FString >& InPayload
)

 Create an event from a previously created blueprint endpoint and a payload. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static FSequencerQuickBindingResult CreateQuickBinding ( UMovieSceneSequence* InSequence,
UObject* InObject,
const FString& InFunctionName,
bool bCallInEditor
)

 Create a quick binding to an actor's member method to be used in an event sequence. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool ExportAnimSequence ( UWorld* World,
ULevelSequence* Sequence,
UAnimSequence* AnimSequence,
UAnimSeqExportOption* ExportOptions,
const FMovieSceneBindingProxy& Binding,
bool bCreateLink
)

 Export Passed in Binding as an Anim Sequence. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool ExportAnimSequenceWaitForDelegate ( UWorld* World,
ULevelSequence* Sequence,
UAnimSequence* AnimSequence,
UAnimSeqExportOption* ExportOptions,
const FMovieSceneBindingProxy& Binding,
bool bCreateLink,
const FCheckCanCompleteDelegate Delegate
)

 Version of ExportAnimSequence, which will spawn in all actors in the sequence and then wait for the provided Delegate to return true before exporting. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool ExportFBXFromControlRig ( ULevelSequence* Sequence,
const FString& ActorWithControlRigTrack,
const UMovieSceneUserExportFBXControlRigSettings* ExportFBXControlRigSettings
)

 Exports an FBX from the section to key of the control rig track of the actor with the given name. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static bool ExportLevelSequenceFBX ( const FSequencerExportFBXParams& InParams
)

 Export Passed in Bindings and Tracks to FBX SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static ULevelSequenceAnimSequenceLink * GetAnimSequenceLinkFromLevelSequence ( ULevelSequence* InLevelSequence
)

 Get the links to the anim sequences if they exist on this level sequence SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static TArray< FSequencerBoundObjects > GetBoundObjects ( UWorld* InWorld,
ULevelSequence* InSequence,
const TArray< FMovieSceneBindingProxy >& InBindings,
const FSequencerScriptingRange& InRange
)

 Retrieve all objects currently bound to the specified binding identifiers. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools"
  • Meta=(DeprecatedFunction)

static UAnimSequenceLevelSequenceLink * GetLevelSequenceLinkFromAnimSequence ( UAnimSequence* InAnimSequence
)

 Get the link to the level sequence if it exists on this anim sequence SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static TArray< FSequencerBoundObjects > GetObjectBindings ( UWorld* InWorld,
ULevelSequence* InSequence,
const TArray< UObject* >& InObject,
const FSequencerScriptingRange& InRange
)

 Get the object bindings for the requested object. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools"
  • Meta=(DeprecatedFunction)

static bool ImportFBXToControlRig ( UWorld* World,
ULevelSequence* InSequence,
const FString& ActorWithControlRigTrack,
const TArray< FString >& SelectedControlRigNames,
UMovieSceneUserImportFBXControlRigSettings* ImportFBXControlRigSettings,
const FString& ImportFilename
)

 Import FBX onto a control rig with the specified track name SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static bool ImportLevelSequenceFBX ( UWorld* InWorld,
ULevelSequence* InSequence,
const TArray< FMovieSceneBindingProxy >& InBindings,
UMovieSceneUserImportFBXSettings* InImportFBXSettings,
const FString& InImportFilename,
ALevelSequenceActor* ActorContext
)

 Import FBX onto Passed in Bindings SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | FBX"

static bool IsEventEndpointValid ( const FSequencerQuickBindingResult& InEndpoint
)

 Check if an endpoint is valid and can be used to create movie scene event. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool IsRenderingMovie()

 Returns if Render to Movie is currently in progress. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Movie Rendering"
  • Meta=(DeprecatedFunction)

static bool LinkAnimSequence ( ULevelSequence* Sequence,
UAnimSequence* AnimSequence,
const UAnimSeqExportOption* ExportOptions,
const FMovieSceneBindingProxy& Binding
)

 Links a LevelSequence's SkeletalMesh binding to an existing anim sequence. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Animation"

static bool RenderMovie ( UMovieSceneCapture* InCaptureSettings,
FOnRenderMovieStopped OnFinishedCallback
)

 Attempts to render a sequence to movie based on the specified settings. SequencerTools.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Movie Rendering"
  • Meta=(DeprecatedFunction)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page