UMovieSceneSequenceExtensions

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

SequencerScripting

Header

/Engine/Plugins/MovieScene/SequencerScripting/Source/SequencerScripting/Public/ExtensionLibraries/MovieSceneSequenceExtensions.h

Include

#include "ExtensionLibraries/MovieSceneSequenceExtensions.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UMovieSceneSequenceExtensions : public UBlueprintFunctionLibrary

Remarks

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

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

int32

 

AddMarkedFrame

(
    UMovieSceneSequence* Sequence,
    const FMovieSceneMarkedFrame& InMa...
)

Add a given user marked frame.

Public function Static UFunction BlueprintCallable, Category, Meta

UMovieSceneT...

 

AddMasterTrack

(
    UMovieSceneSequence* Sequence,
    TSubclassOf< UMovieSceneTrack > Tra...
)

Add a new master track of the specified type

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerBi...

 

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

UMovieSceneF...

 

AddRootFolderToSequence

(
    UMovieSceneSequence* Sequence,
    FString NewFolderName
)

Add a root folder to the given sequence

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerBi...

 

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

FSequencerBi...

 

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

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

 

DeleteMarkedFrames

(
    UMovieSceneSequence* Sequence
)

Delete all user marked frames

Public function Static

TArray< UMov...

 

FilterTracks

(
    TArrayView< UMovieSceneTrack*c...,
    UClass* DesiredClass,
    bool bExactMatch
)

Filter the specified array of tracks by class, optionally only matching exact classes

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerBi...

 

FindBindingById

(
    UMovieSceneSequence* Sequence,
    FGuid BindingId
)

Attempt to locate a binding in this sequence by its Id

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerBi...

 

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
)

Find the user marked frame by frame number

The 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 label

The label to the user marked frame to find

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< UMov...

 

FindMasterTracksByExactType

(
    UMovieSceneSequence* Sequence,
    TSubclassOf< UMovieSceneTrack > Tra...
)

Find all master tracks of the specified type, not allowing sub-classed types

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< UMov...

 

FindMasterTracksByType

(
    UMovieSceneSequence* Sequence,
    TSubclassOf< UMovieSceneTrack > Tra...
)

Find all master tracks of the specified type

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

FMovieSceneO...

 

GetBindingID

(
    const FSequencerBindingProxy& InBi...
)

Get the binding ID for a binding within a sequence.

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< FSeq...

 

GetBindings

(
    UMovieSceneSequence* Sequence
)

Get all the bindings in this sequence

Public function Static UFunction BlueprintPure, Category, Meta

EUpdateClock...

 

GetClockSource

(
    UMovieSceneSequence* InSequenc...
)

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

EMovieSceneE...

 

GetEvaluationType

(
    UMovieSceneSequence* InSequenc...
)

Get the evaluation type for this sequence

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< FMov...

 

GetMarkedFrames

(
    UMovieSceneSequence* Sequence
)

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< UMov...

 

GetMasterTracks

(
    UMovieSceneSequence* Sequence
)

Get all master tracks

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

FSequencerSc...

 

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

FMovieSceneO...

 

GetPortableBindingID

(
    UMovieSceneSequence* MasterSeq...,
    UMovieSceneSequence* Destinati...,
    const FSequencerBindingProxy& InBi...
)

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< FSeq...

 

GetPossessables

(
    UMovieSceneSequence* Sequence
)

Get all the possessables in this sequence

Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta

TArray< UMov...

 

GetRootFoldersInSequence

(
    UMovieSceneSequence* Sequence
)

Get the root folders in the provided sequence

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< FSeq...

 

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

FTimecode

 

GetTimecodeSource

(
    UMovieSceneSequence* Sequence
)

Get the timecode source of this sequence

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetViewRangeEnd

(
    UMovieSceneSequence* InSequenc...
)

Get the sequence view range end in seconds

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetViewRangeStart

(
    UMovieSceneSequence* InSequenc...
)

Get the sequence view range start in seconds

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetWorkRangeEnd

(
    UMovieSceneSequence* InSequenc...
)

Get the sequence work range end in seconds

Public function Static UFunction BlueprintPure, Category, Meta

float

 

GetWorkRangeStart

(
    UMovieSceneSequence* InSequenc...
)

Get the sequence work range start in seconds

Public function Static

bool

 

IsReadOnly

(
    UMovieSceneSequence* Sequence
)

Is read only

Public function Static UFunction BlueprintCallable, Category, Meta

TArray< UObj...

 

LocateBoundObjects

(
    UMovieSceneSequence* Sequence,
    const FSequencerBindingProxy& InBi...,
    UObject* Context
)

Locate all the objects that correspond to the specified object ID, using the specified context

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerSc...

 

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

FSequencerSc...

 

MakeRangeSeconds

(
    UMovieSceneSequence* Sequence,
    float StartTime,
    float Duration
)

Make a new range for this sequence in seconds

Public function Static UFunction BlueprintCallable, Category, Meta

bool

 

RemoveMasterTrack

(
    UMovieSceneSequence* Sequence,
    UMovieSceneTrack* MasterTrack
)

Removes a master track

Public function Static UFunction BlueprintCallable, Category, Meta

FSequencerBi...

 

ResolveBindingID

(
    UMovieSceneSequence* MasterSeq...,
    FMovieSceneObjectBindingID InObject...
)

Make a binding for the given binding ID

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetClockSource

(
    UMovieSceneSequence* InSequenc...,
    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* InSequenc...,
    EMovieSceneEvaluationType InEvaluat...
)

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

 

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

 

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

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* InSequenc...,
    float EndTimeInSeconds
)

Set the sequence view range end in seconds

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetViewRangeStart

(
    UMovieSceneSequence* InSequenc...,
    float StartTimeInSeconds
)

Set the sequence view range start in seconds

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetWorkRangeEnd

(
    UMovieSceneSequence* InSequenc...,
    float EndTimeInSeconds
)

Set the sequence work range end in seconds

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetWorkRangeStart

(
    UMovieSceneSequence* InSequenc...,
    float 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

Deprecated Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

FMovieSceneO...

 

MakeBindingID

(
    UMovieSceneSequence* MasterSeq...,
    const FSequencerBindingProxy& InBi...,
    EMovieSceneObjectBindingSpace Space
)

Please migrate to GetBindingID or GetPortableBindingID depending on use-case.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss