Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieScene > UMovieScene

Light Theme

Dark Theme

UMovieScene

Implements a movie scene asset.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSignedObject

UMovieScene

References

Module	MovieScene
Header	/Engine/Source/Runtime/MovieScene/Public/MovieScene.h
Include	#include "MovieScene.h"

Syntax

class UMovieScene : public UMovieSceneSignedObject

Remarks

Implements a movie scene asset.

Variables

		Name	Description
	FMovieSceneTime...	TimecodeSource	The timecode at which this movie scene section is based (ie. when it was recorded)

Constructors

	Name	Description
	UMovieScene ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
UMovieSceneT...	AddCameraCutTrack ( TSubclassOf< UMovieSceneTrack > Tra... )	Adds a new camera cut track if it doesn't exist A camera cut track allows for cutting between camera views There is only one per movie scene.
bool	AddGivenMasterTrack ( UMovieSceneTrack* InTrack )	Adds a given track as a master track
bool	AddGivenTrack ( UMovieSceneTrack* InTrack, const FGuid& ObjectGuid )	Adds a given track.
int32	AddMarkedFrame ( const FMovieSceneMarkedFrame& InMa... )	Add a given user marked frame.
UMovieSceneT...	AddMasterTrack ( TSubclassOf< UMovieSceneTrack > Tra... )	Adds a master track. The type should not already exist.
TrackClass &...	AddMasterTrack()	Adds a master track. The type should not already exist.
void	AddNewBindingTag ( const FName& NewTag )	Add a new binding group for the specified name
void	AddPossessable ( const FMovieScenePossessable& InNe..., const FMovieSceneBinding& InNewBin... )	Adds an existing possessable to this movie scene.
FGuid	AddPossessable ( const FString& Name, UClass* Class )	Adds a possessable to this movie scene.
FGuid	AddSpawnable ( const FString& Name, UObject& ObjectTemplate )	Add a spawnable to this movie scene's list of owned blueprints.
void	AddSpawnable ( const FMovieSceneSpawnable& InNewS..., const FMovieSceneBinding& InNewBin... )	Adds an existing spawnable to this movie scene.
TrackClass &...	AddTrack ( const FGuid& ObjectGuid )	Adds a track. The type should not already exist.
UMovieSceneT...	AddTrack ( TSubclassOf< UMovieSceneTrack > Tra..., const FGuid& ObjectGuid )	Adds a track. The type should not already exist.
const TMap< ...	AllTaggedBindings()	Retrieve all the tagged binding groups for this movie scene
void	CleanSectionGroups()	Cleans stale UMovieSceneSection pointers, and removes any section groups which are no longer valid, e.g. contain less that two valid sections
void	DeleteMarkedFrame ( int32 DeleteIndex )	Delete the user marked frame by index. The index to the user marked frame to delete
void	DeleteMarkedFrames()	Delete all user marked frames
FMovieSceneB...	FindBinding ( const FGuid& ForGuid )	Tries to find an FMovieSceneBinding for the specified Guid.
int32	FindMarkedFrameByFrameNumber ( FFrameNumber InFrameNumber )	Find the user marked frame by frame number The frame number of the user marked frame to find
int32	FindMarkedFrameByLabel ( const FString& InLabel )	Find the user marked frame by label The label to the user marked frame to find
UMovieSceneT...	FindMasterTrack ( TSubclassOf< UMovieSceneTrack > Tra... )	Finds a master track (one not bound to a runtime objects).
TrackClass &...	FindMasterTrack()	Finds a master track (one not bound to a runtime objects).
int32	FindNextMarkedFrame ( FFrameNumber InFrameNumber, bool bForward )	Find the next/previous user marked frame from the given frame number
FMovieSceneP...	FindPossessable ( const TFunctionRef< bool... )	Attempt to find a possessable using some custom prdeicate
FMovieSceneP...	FindPossessable ( const FGuid& Guid )	Tries to locate a possessable in this MovieScene for the specified possessable GUID.
FMovieSceneS...	FindSpawnable ( const FGuid& Guid )	Tries to locate a spawnable in this MovieScene for the specified spawnable GUID.
FMovieSceneS...	FindSpawnable ( const TFunctionRef< bool... )	Attempt to find a spawnable using some custom predicate
UMovieSceneT...	FindTrack ( TSubclassOf< UMovieSceneTrack > Tra..., const FGuid& ObjectGuid, const FName& TrackName )	Finds a track.
TrackClass &...	FindTrack ( const FGuid& ObjectGuid, const FName& TrackName )	Finds a track.
bool	FindTrackBinding ( const UMovieSceneTrack& InTrack, FGuid& OutGuid )	Find a track binding Guid from a UMovieSceneTrack
TArray< UMov...	GetAllSections()	Returns all sections and their associated binding data.
const TArray...	GetBindings()
UMovieSceneT...	GetCameraCutTrack()
EUpdateClock...	GetClockSource()	Retrieve the clock source to be used for this moviescene
FFrameRate	GetDisplayRate()	Retrieve the display frame rate for this data, in which frame numbers should be displayed on UI, and interacted with in movie scene players
FMovieSceneE...	GetEditorData()
EMovieSceneE...	GetEvaluationType()	Retrieve a value signifying how to evaluate this movie scene data
bool	GetGloballyShowMarkedFrames()	Returns whether this scene's marked frames should be shown globally
const TArray...	GetMarkedFrames()
const TArray...	GetMasterTracks()	Get all master tracks.
TArray< FStr...	GetMuteNodes()	Gets the nodes marked as muted in the editor, as node tree paths
UMovieSceneN...	GetNodeGroups()
FText	GetObjectDisplayName ( const FGuid& ObjectId )	Get the display name of the object with the specified identifier.
TMap< FStrin...	GetObjectsToLabels()
TRange< FFra...	GetPlaybackRange()	Get the playback time range of this movie scene, relative to its 0-time offset.
FMovieSceneP...	GetPossessable ( const int32 Index )	Grabs a reference to a specific possessable by index.
int32	GetPossessableCount()	Get the number of possessable objects in this scene.
TArray< UMov...	GetRootFolders()	Gets the root folders for this movie scene.
const FMovie...	GetSectionGroup ( const UMovieSceneSection& InSectio... )
TRange< FFra...	GetSelectionRange()	Get the current selection range.
TArray< FStr...	GetSoloNodes()	Gets the nodes marked as solo in the editor, as node tree paths
FMovieSceneS...	GetSpawnable ( int32 Index )	Grabs a reference to a specific spawnable by index.
int32	GetSpawnableCount()	Get the number of spawnable objects in this scene.
FFrameRate	GetTickResolution()	Retrieve the tick resolution at which all frame numbers within this movie scene are defined
void	GroupSections ( const TArray< UMovieSceneSection&#... )	Create a group containing InSections, merging any existing groups the sections are in
bool	IsAMasterTrack ( const UMovieSceneTrack& Track )	Check whether the specified track is a master track in this scene.
bool	IsPlaybackRangeLocked()	Return whether the playback range is locked.
bool	IsReadOnly()
bool	IsSectionInGroup ( const UMovieSceneSection& InSectio... )
TSharedPtr< ...	MakeCustomTimeController ( UObject* PlaybackContext )	Retrieve a time controller from this sequence instance, if the clock source is set to custom
void	MoveBindingContents ( const FGuid& SourceBindingId, const FGuid& DestinationBindingId )	Move all the contents (tracks, child bindings) of the specified binding ID onto another
FMovieSceneO...	OnChannelChanged()	WIP Set of Delegates.
void	RemoveBinding ( const FGuid& Guid )	Removes animation data bound to a GUID.
void	RemoveCameraCutTrack()	Removes the camera cut track if it exists.
bool	RemoveMasterTrack ( UMovieSceneTrack& Track )	Removes a master track.
bool	RemovePossessable ( const FGuid& PossessableGuid )	Removes a possessable from this movie scene.
bool	RemoveSpawnable ( const FGuid& Guid )	Removes a spawnable from this movie scene.
void	RemoveTag ( const FName& TagToRemove )	Remove the specified tag from any binding and forget about it completely
bool	RemoveTrack ( UMovieSceneTrack& Track )	Removes a track.
void	ReplaceBinding ( const FGuid& OldGuid, const FGuid& NewGuid, const FString& Name )	Replace an existing binding with another
void	ReplaceBinding ( const FGuid& BindingToReplaceGuid, const FMovieSceneBinding& NewBindi... )	Replace an existing binding with another.
bool	ReplacePossessable ( const FGuid& OldGuid, const FMovieScenePossessable& InNe... )	Replace an existing possessable with another
void	SetCameraCutTrack ( UMovieSceneTrack* Track )
void	SetClockSource ( EUpdateClockSource InNewClockSource )	Assign the clock source to be used for this moviescene
void	SetClockSource ( UObject* InNewClockSource )	Assign the clock source to be used for this moviescene
void	SetDisplayRate ( FFrameRate InDisplayRate )	Set the play rate for this movie scene
void	SetEditorData ( FMovieSceneEditorData& InEditorDat... )
void	SetEvaluationType ( EMovieSceneEvaluationType InNewEval... )	Assign a value signifying how to evaluate this movie scene data
void	SetGloballyShowMarkedFrames ( bool bShowMarkedFrames )	Set whether this scene's marked frames should be shown globally
void	SetMarkedFrame ( int32 InMarkIndex, FFrameNumber InFrameNumber )	Sets the frame number for the given marked frame index.
void	SetObjectDisplayName ( const FGuid& ObjectId, const FText& DisplayName )	Get the display name of the object with the specified identifier.
void	SetPlaybackRange ( const TRange< FFrameNumber >& NewR..., bool bAlwaysMarkDirty )	Set the playback range for this movie scene
void	SetPlaybackRange ( FFrameNumber Start, int32 Duration, bool bAlwaysMarkDirty )	Set the start and end playback positions (playback range) for this movie scene
void	SetPlaybackRangeLocked ( bool bLocked )	Set whether the playback range is locked.
void	SetReadOnly ( bool bInReadOnly )	Set whether this movie scene is read only.
void	SetSelectionRange ( TRange< FFrameNumber > Range )	Set the selection range.
void	SetTickResolutionDirectly ( FFrameRate InTickResolution )	Directly set the tick resolution for this movie scene without applying any conversion whatsoever, or modifying the data
void	SetViewRange ( float Start, float End )	Set the start and end view range (inner) for this movie scene
void	SetWorkingRange ( float Start, float End )	Set the start and end working range (outer) for this movie scene
void	SortMarkedFrames()	Sort the marked frames in chronological order
void	TagBinding ( const FName& NewTag, const UE::MovieScene::FFixedObjectB... )	Tag the specified binding ID with the specified name
void	ToggleGloballyShowMarkedFrames()	Toggle whether this scene's marked frames should be shown globally
void	UngroupSection ( const UMovieSceneSection& InSectio... )	Remove InSection from any group it currently is in
void	UntagBinding ( const FName& Tag, const UE::MovieScene::FFixedObjectB... )	Remove a tag from the specified object binding
void	UpgradeTimeRanges()	Perform legacy upgrade of time ranges

Overridden from UObject

	Name	Description
bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Called before this object is being deserialized.
void	Serialize ( FArchive& Ar )	~ UObject implementation

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss