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

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • USequencerToolsFunctionLibrary

References

   
Module SequencerScriptingEditor
Header /Engine/Plugins/MovieScene/SequencerScripting/Source/SequencerScriptingEditor/Public/SequencerTools.h
Include #include "SequencerTools.h"

Syntax

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

Remarks

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.

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta void Attempts to cancel an in-progress Render to Movie. Does nothing if there is no render in progress.
Public function Static UFunction BlueprintCallable, Category void Clear all linked anim sequences between this level sequence and any linked anim sequences
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category bool

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

 Export Passed in Binding as an Anim Seqquence.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category bool Export Passed in Bindings and Tracks to FBX
Public function Static UFunction BlueprintCallable, Category ULevelSequenceAnimSequenceLink * Get the links to the anim sequences if they exist on this level sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FSequencerBoundObjects >

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

 Retrieve all objects currently bound to the specified binding identifiers.
Public function Static UFunction BlueprintCallable, Category UAnimSequenceLevelSequenceLink *

GetLevelSequenceLinkFromAnimSequence ( UAnimSequence* InAnimSequence
)

 Get the link to the level sequence if it exists on this anim sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FSequencerBoundObjects >

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

 Get the object bindings for the requested object.
Public function Static UFunction BlueprintCallable, Category 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
Public function Static UFunction BlueprintCallable, Category bool

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

 Import FBX onto Passed in Bindings
Public function Static UFunction BlueprintCallable, Category bool Check if an endpoint is valid and can be used to create movie scene event.
Public function Static UFunction BlueprintCallable, Category, Meta bool Returns if Render to Movie is currently in progress.
Public function Static UFunction BlueprintCallable, Category bool

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

 Links a LevelSequence's SkeletalMesh binding to an existing anim sequence.
Public function Static UFunction BlueprintCallable, Category, Meta bool

RenderMovie ( UMovieSceneCapture* InCaptureSettings,
FOnRenderMovieStopped OnFinishedCallback
)

 Attempts to render a sequence to movie based on the specified settings.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page