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

References

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

Syntax

UCLASS&40;&41;  
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
)

 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
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 * Add a new track of the specified type
Public function Static UFunction BlueprintCallable, Category, Meta bool Are marked frames locked
Public function Static UFunction BlueprintCallable, Category, Meta void

DeleteMarkedFrame ( UMovieSceneSequence* Sequence,
int32 DeleteIndex
)

 Delete the user marked frame by index.The index to the user marked frame to delete
Public function Static UFunction BlueprintCallable, Category, Meta void 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 Attempt to locate a binding in this sequence by its name
Public function Static UFunction BlueprintCallable, Category, Meta int32 Find the user marked frame by frame numberThe frame number of the user marked frame to find
Public function Static UFunction BlueprintCallable, Category, Meta int32

FindMarkedFrameByLabel ( UMovieSceneSequence* Sequence,
const FString& InLabel
)

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

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

 Find the next/previous user marked frame from the given frame number
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > Find all tracks of the specified type, not allowing sub-classed types
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > 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 > Get all the bindings in this sequence
Public function Static UFunction BlueprintPure, Category, Meta EUpdateClockSource Get the clock source for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta FFrameRate Gets this sequence's display rate
Public function Static UFunction BlueprintPure, Category, Meta EMovieSceneEvaluationType Get the evaluation type for this sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneMarkedFrame >  
Public function Static UFunction BlueprintCallable, Category, Meta UMovieScene * Get this sequence's movie scene data
Public function Static UFunction BlueprintCallable, Category, Meta int32 Get playback end of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta float Get playback end of this sequence in seconds
Public function Static UFunction BlueprintCallable, Category, Meta FSequencerScriptingRange Get playback range of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta int32 Get playback start of this sequence in display rate resolution
Public function Static UFunction BlueprintCallable, Category, Meta float 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 > Get all the possessables in this sequence
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta TArray< UMovieSceneFolder * > Get the root folders in the provided sequence
Public function Static UFunction BlueprintCallable, Category, Meta TArray< FMovieSceneBindingProxy > Get all the spawnables in this sequence
Public function Static UFunction BlueprintCallable, Category, Meta FFrameRate Gets this sequence's tick resolution
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > Get all tracks
Public function Static UFunction BlueprintPure, Category, Meta float Get the sequence view range end in seconds
Public function Static UFunction BlueprintPure, Category, Meta float Get the sequence view range start in seconds
Public function Static UFunction BlueprintPure, Category, Meta float Get the sequence work range end in seconds
Public function Static UFunction BlueprintPure, Category, Meta float Get the sequence work range start in seconds
Public function Static UFunction BlueprintCallable, Category, Meta bool Is playback ranged locked
Public function Static UFunction BlueprintCallable, Category, Meta bool 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 Remove a root folder from the given sequence.
Public function Static UFunction BlueprintCallable, Category, Meta bool 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
)

 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 lockedWhether 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 lockedWhether 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 onlyWhether 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 Sets this sequence's tick resolution directly without migrating frame times
Public function Static UFunction BlueprintCallable, Category, Meta void

SetViewRangeEnd ( UMovieSceneSequence* InSequence,
float EndTimeInSeconds
)

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

SetViewRangeStart ( UMovieSceneSequence* InSequence,
float StartTimeInSeconds
)

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

SetWorkRangeEnd ( UMovieSceneSequence* InSequence,
float EndTimeInSeconds
)

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

SetWorkRangeStart ( UMovieSceneSequence* InSequence,
float StartTimeInSeconds
)

 Set the sequence work range start in seconds
Public function Static UFunction BlueprintCallable, Category, Meta void Sort the marked frames in chronological order

Deprecated Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta UMovieSceneTrack * AddMasterTrack is deprecated. Please use AddTrack instead
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > FindMasterTracksByExactType is deprecated. Please use FindTracksByExactType instead
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > FindMasterTracksByType is deprecated. Please use FindTracksByType instead
Public function Static UFunction BlueprintCallable, Category, Meta TArray< UMovieSceneTrack * > GetMasterTracks is deprecated. Please use GetTracks instead
Public function Static UFunction BlueprintCallable, Category, Meta bool RemoveMasterTrack is deprecated. Please use RemoveTrack instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page