1. Epic GamesDeveloper
  3. UMovieSceneSequenceExtensions

UMovieSceneSequenceExtensions

Function library containing methods that should be hoisted onto UMovieSceneSequences for scripting purposes

API > API/Plugins > API/Plugins/SequencerScripting > API/Plugins/SequencerScripting/ExtensionLibraries

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UMovieSceneSequenceExtensions

References

   
Module SequencerScripting
Header /Engine/Plugins/MovieScene/SequencerScripting/Source/SequencerScripting/Public/ExtensionLibraries/MovieSceneSequenceExtensions.h
Include #include "ExtensionLibraries/MovieSceneSequenceExtensions.h"

Syntax

UCLASS ()  
class UMovieSceneSequenceExtensions : public UBlueprintFunctionLibrary

Remarks

Function library containing methods that should be hoisted onto UMovieSceneSequences for scripting purposes

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta int32

AddMarkedFrame ( UMovieSceneSequence* Sequence,
const FMovieSceneMarkedFrame& InMarkedFrame
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int32

AddMarkedFrameToSequence ( UMovieSceneSequence* Sequence,
const FMovieSceneMarkedFrame& InMarkedFrame,
EMovieSceneTimeUnit TimeUnit
)

 Add a given user marked frame.
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

AddPossessable ( UMovieSceneSequence* Sequence,
UObject* ObjectToPossess
)

 Add a new binding to this sequence that will possess the specified object
Public function Static UFunction BlueprintCallable, Category, Meta UMovieSceneFolder *

AddRootFolderToSequence ( UMovieSceneSequence* Sequence,
FString NewFolderName
)

 Add a root folder to the given sequence
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

AddSpawnableFromClass ( UMovieSceneSequence* Sequence,
UClass* ClassToSpawn
)

 Add a new binding to this sequence that will spawn the specified object For level sequences this will make a custom binding of type UMovieSceneSpawnableActorBinding.
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

AddSpawnableFromInstance ( UMovieSceneSequence* Sequence,
UObject* ObjectToSpawn
)

 Add a new binding to this sequence that will spawn the specified object.
Public function Static UFunction BlueprintCallable, Category, Meta UMovieSceneTrack *

AddTrack ( UMovieSceneSequence* Sequence,
TSubclassOf< UMovieSceneTrack > TrackType
)

 Add a new track of the specified type
Public function Static UFunction BlueprintCallable, Category, Meta bool

AreMarkedFramesLocked ( UMovieSceneSequence* Sequence
)

 Are marked frames locked
Public function Static UFunction BlueprintCallable, Category, Meta void

DeleteMarkedFrame ( UMovieSceneSequence* Sequence,
int32 DeleteIndex
)

 Delete the user marked frame by index.@DeleteIndex The index to the user marked frame to delete
Public function Static UFunction BlueprintCallable, Category, Meta void

DeleteMarkedFrames ( UMovieSceneSequence* Sequence
)

 Delete all user marked frames
Public function Static TArray< UMovieSceneTrack * >

FilterTracks ( TArrayView< UMovieSceneTrack*const > InTracks,
UClass* DesiredClass,
bool bExactMatch
)

 Filter the specified array of tracks by class, optionally only matching exact classes
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

FindBindingById ( UMovieSceneSequence* Sequence,
FGuid BindingId
)

 Attempt to locate a binding in this sequence by its Id
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

FindBindingByName ( UMovieSceneSequence* Sequence,
FString Name
)

 Attempt to locate a binding in this sequence by its name
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindMarkedFrameByFrameNumber ( UMovieSceneSequence* Sequence,
FFrameNumber InFrameNumber
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindMarkedFrameByFrameNumberInSequence ( UMovieSceneSequence* Sequence,
FFrameNumber InFrameNumber,
EMovieSceneTimeUnit TimeUnit
)

 Find the user marked frame by frame number
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindMarkedFrameByLabel ( UMovieSceneSequence* Sequence,
const FString& InLabel
)

 Find the user marked frame by label@InLabel The label to the user marked frame to find
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindNextMarkedFrame ( UMovieSceneSequence* Sequence,
FFrameNumber InFrameNumber,
bool bForward
)

  
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindNextMarkedFrameInSequence ( UMovieSceneSequence* Sequence,
FFrameNumber InFrameNumber,
bool bForward,
EMovieSceneTimeUnit TimeUnit
)

 Find the next/previous user marked frame from the given frame number
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * >

FindTracksByExactType ( UMovieSceneSequence* Sequence,
TSubclassOf< UMovieSceneTrack > TrackType
)

 Find all tracks of the specified type, not allowing sub-classed types
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * >

FindTracksByType ( UMovieSceneSequence* Sequence,
TSubclassOf< UMovieSceneTrack > TrackType
)

 Find all tracks of the specified type
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneObjectBindingID

GetBindingID ( UMovieSceneSequence* Sequence,
const FMovieSceneBindingProxy& InBinding
)

 Get the binding ID for a binding within a sequence.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneBindingProxy >

GetBindings ( UMovieSceneSequence* Sequence
)

 Get all the bindings in this sequence
Public function Static UFunction BlueprintPure, Category, Meta EUpdateClockSource

GetClockSource ( UMovieSceneSequence* InSequence
)

 Get the clock source for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta FFrameRate

GetDisplayRate ( UMovieSceneSequence* Sequence
)

 Gets this sequence's display rate
Public function Static UFunction BlueprintPure, Category, Meta EMovieSceneEvaluationType

GetEvaluationType ( UMovieSceneSequence* InSequence
)

 Get the evaluation type for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneMarkedFrame >

GetMarkedFrames ( UMovieSceneSequence* Sequence
)

  
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneMarkedFrame >

GetMarkedFramesFromSequence ( UMovieSceneSequence* Sequence,
EMovieSceneTimeUnit TimeUnit
)

 Get the marked frames for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta UMovieScene *

GetMovieScene ( UMovieSceneSequence* Sequence
)

 Get this sequence's movie scene data
Public function Static UFunction BlueprintCallable, Category, Meta int32

GetPlaybackEnd ( UMovieSceneSequence* Sequence
)

 Get playback end of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta float

GetPlaybackEndSeconds ( UMovieSceneSequence* Sequence
)

 Get playback end of this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta FSequencerScriptingRange

GetPlaybackRange ( UMovieSceneSequence* Sequence
)

 Get playback range of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta int32

GetPlaybackStart ( UMovieSceneSequence* Sequence
)

 Get playback start of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta float

GetPlaybackStartSeconds ( UMovieSceneSequence* Sequence
)

 Get playback start of this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneObjectBindingID

GetPortableBindingID ( UMovieSceneSequence* RootSequence,
UMovieSceneSequence* DestinationSequence,
const FMovieSceneBindingProxy& InBinding
)

 Get a portable binding ID for a binding that resides in a different sequence to the one where this binding will be resolved.
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneBindingProxy >

GetPossessables ( UMovieSceneSequence* Sequence
)

 Get all the possessables in this sequence.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta TArray< UMovieSceneFolder * >

GetRootFoldersInSequence ( UMovieSceneSequence* Sequence
)

 Get the root folders in the provided sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneBindingProxy >

GetSpawnables ( UMovieSceneSequence* Sequence
)

 Get all the spawnables in this sequence.
Public function Static UFunction BlueprintCallable, Category, Meta FFrameRate

GetTickResolution ( UMovieSceneSequence* Sequence
)

 Gets this sequence's tick resolution
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * >

GetTracks ( UMovieSceneSequence* Sequence
)

 Get all tracks
Public function Static UFunction BlueprintPure, Category, Meta double

GetViewRangeEnd ( UMovieSceneSequence* InSequence
)

 Get the sequence view range end in seconds
Public function Static UFunction BlueprintPure, Category, Meta double

GetViewRangeStart ( UMovieSceneSequence* InSequence
)

 Get the sequence view range start in seconds
Public function Static UFunction BlueprintPure, Category, Meta double

GetWorkRangeEnd ( UMovieSceneSequence* InSequence
)

 Get the sequence work range end in seconds
Public function Static UFunction BlueprintPure, Category, Meta double

GetWorkRangeStart ( UMovieSceneSequence* InSequence
)

 Get the sequence work range start in seconds
Public function Static UFunction BlueprintCallable, Category, Meta bool

IsPlaybackRangeLocked ( UMovieSceneSequence* Sequence
)

 Is playback ranged locked
Public function Static UFunction BlueprintCallable, Category, Meta bool

IsReadOnly ( UMovieSceneSequence* Sequence
)

 Is read only
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UObject * >

LocateBoundObjects ( UMovieSceneSequence* Sequence,
const FMovieSceneBindingProxy& InBinding,
UObject* Context
)

 Locate all the objects that correspond to the specified object ID, using the specified context
Public function Static UFunction BlueprintCallable, Category, Meta FSequencerScriptingRange

MakeRange ( UMovieSceneSequence* Sequence,
int32 StartFrame,
int32 Duration
)

 Make a new range for this sequence in its display rate
Public function Static UFunction BlueprintCallable, Category, Meta FSequencerScriptingRange

MakeRangeSeconds ( UMovieSceneSequence* Sequence,
float StartTime,
float Duration
)

 Make a new range for this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

RemoveRootFolderFromSequence ( UMovieSceneSequence* Sequence,
UMovieSceneFolder* Folder
)

 Remove a root folder from the given sequence.
Public function Static UFunction BlueprintCallable, Category, Meta bool

RemoveTrack ( UMovieSceneSequence* Sequence,
UMovieSceneTrack* Track
)

 Removes a track
Public function Static UFunction BlueprintCallable, Category, Meta FMovieSceneBindingProxy

ResolveBindingID ( UMovieSceneSequence* RootSequence,
FMovieSceneObjectBindingID InObjectBindingID
)

 Make a binding for the given binding ID
Public function Static UFunction BlueprintCallable, Category, Meta void

SetClockSource ( UMovieSceneSequence* InSequence,
EUpdateClockSource InClockSource
)

 Set the clock source for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta void

SetDisplayRate ( UMovieSceneSequence* Sequence,
FFrameRate DisplayRate
)

 Sets this sequence's display rate
Public function Static UFunction BlueprintCallable, Category, Meta void

SetEvaluationType ( UMovieSceneSequence* InSequence,
EMovieSceneEvaluationType InEvaluationType
)

 Set the evaluation type for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMarkedFrame ( UMovieSceneSequence* Sequence,
int32 InMarkIndex,
FFrameNumber InFrameNumber
)

  
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMarkedFrameInSequence ( UMovieSceneSequence* Sequence,
int32 InMarkIndex,
FFrameNumber InFrameNumber,
EMovieSceneTimeUnit TimeUnit
)

 Sets the frame number for the given marked frame index.
Public function Static UFunction BlueprintCallable, Category, Meta void

SetMarkedFramesLocked ( UMovieSceneSequence* Sequence,
bool bInLocked
)

 Set marked frames locked@bInLocked Whether the movie scene marked frames should be locked
Public function Static UFunction BlueprintCallable, Category, Meta void

SetPlaybackEnd ( UMovieSceneSequence* Sequence,
int32 EndFrame
)

 Set playback end of this sequence
Public function Static UFunction BlueprintCallable, Category, Meta void

SetPlaybackEndSeconds ( UMovieSceneSequence* Sequence,
float EndTime
)

 Set playback end of this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SetPlaybackRangeLocked ( UMovieSceneSequence* Sequence,
bool bInLocked
)

 Set playback range locked@bInLocked Whether the movie scene playback range should be locked
Public function Static UFunction BlueprintCallable, Category, Meta void

SetPlaybackStart ( UMovieSceneSequence* Sequence,
int32 StartFrame
)

 Set playback start of this sequence
Public function Static UFunction BlueprintCallable, Category, Meta void

SetPlaybackStartSeconds ( UMovieSceneSequence* Sequence,
float StartTime
)

 Set playback start of this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SetReadOnly ( UMovieSceneSequence* Sequence,
bool bInReadOnly
)

 Set read only@bInReadOnly Whether the movie scene should be read only or not
Public function Static UFunction BlueprintCallable, Category, Meta void

SetTickResolution ( UMovieSceneSequence* Sequence,
FFrameRate TickResolution
)

 Sets this sequence's tick resolution and migrates frame times
Public function Static UFunction BlueprintCallable, Category, Meta void

SetTickResolutionDirectly ( UMovieSceneSequence* Sequence,
FFrameRate TickResolution
)

 Sets this sequence's tick resolution directly without migrating frame times
Public function Static UFunction BlueprintCallable, Category, Meta void

SetViewRangeEnd ( UMovieSceneSequence* InSequence,
double EndTimeInSeconds
)

 Set the sequence view range end in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SetViewRangeStart ( UMovieSceneSequence* InSequence,
double StartTimeInSeconds
)

 Set the sequence view range start in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SetWorkRangeEnd ( UMovieSceneSequence* InSequence,
double EndTimeInSeconds
)

 Set the sequence work range end in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SetWorkRangeStart ( UMovieSceneSequence* InSequence,
double StartTimeInSeconds
)

 Set the sequence work range start in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void

SortMarkedFrames ( UMovieSceneSequence* Sequence
)

 Sort the marked frames in chronological order

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page