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

Light Theme

Dark Theme

MovieScene

Windows

MacOS

Linux

Filters

Classes

	Name	Description
	EMovieSceneCameraCutParams	Camera cut parameters
	EMovieSceneViewportParams
	FFBXNodeAndChannels	For import data onto channels directly.
	FFixedObjectBindingID	A binding ID that is only resolveable through a fixed root sequence.
	FGeneratedMovieSceneKeyStruct
	FMovieSceneBinding	A set of tracks bound to runtime objects
	FMovieSceneBindingOverrideData	Movie scene binding override data
	FMovieSceneChannelValueHelper	Utility class that gets and sets a specific key value for a key struct
	FMovieSceneClipboard	A clipboard representing serializable copied data for a movie scene
	FMovieSceneClipboardBuilder	Class responsible for building a clipboard for a movie scene
	FMovieSceneClipboardEnvironment	Structure representing an environment a clipboard applies to
	FMovieSceneClipboardKey	A key in the clipboard representing a time and a value of a specific type Client code must define MovieSceneClipboard::GetKeyTypeName<> in order to use a type with this class.
	FMovieSceneClipboardKeyTrack	Container for a collection of keys arranged in a track.
	FMovieSceneEasingSettings
	FMovieSceneEditorData	Editor only data that needs to be saved between sessions for editing but has no runtime purpose
	FMovieSceneEvaluationGroupParameters
	FMovieSceneExpansionState
	FMovieSceneFrameRange	Type used to convert from a FFloatRange to a TRange
	FMovieSceneKeyStruct	Base class for movie scene section key structs that need to manually have their changes propagated to key values.
	FMovieSceneKeyStructHelper	Helper class that marshals user-facing data from an edit UI into particluar keys on various underlying channels
	FMovieSceneKeyTimeStruct
	FMovieSceneLatentActionManager	Utility class for running latent actions created from sequence players.
	FMovieSceneMarkedFrame
	FMovieSceneObjectBindingID	Persistent identifier to a specific object binding within a sequence hierarchy.
	FMovieSceneObjectBindingIDs	Structure that comprises a list of object binding IDs
	FMovieScenePossessable	MovieScenePossessable is a "typed slot" used to allow the MovieScene to control an already-existing object
	FMovieSceneSectionEvalOptions
	FMovieSceneSectionGroup	Structure that represents a group of sections
	FMovieSceneSectionMovedParams	Parameters for sections moving in the editor
	FMovieSceneSequenceActorPointers	A structure for storing pointers to a sequence actor.
	FMovieSceneSequenceID
	FMovieSceneSequenceLoopCount	POD struct that represents a number of loops where -1 signifies infinite looping, 0 means no loops, etc Defined as a struct rather than an int so a property type customization can be bound to it
	FMovieSceneSequencePlaybackParams
	FMovieSceneSequencePlaybackSettings	Settings for the level sequence player actor.
	FMovieSceneSequenceReplProperties	Properties that are broadcast from server->clients for time/state synchronization
	FMovieSceneSpawnable	MovieSceneSpawnable describes an object that can be spawned for this MovieScene
	FMovieSceneSpawnableAnnotation	An annotation that's added to spawned objects from movie scene spawnables
	FMovieSceneSpawnRegister	Class responsible for managing spawnables in a movie scene
	FMovieSceneSupportsEasingParams	Parameters for the `SupportsEasing_ method
	FMovieSceneTimecodeSource
	FMovieSceneTimeController
	FMovieSceneTimeController_AudioClock	A timing manager that retrieves its time from the audio clock
	FMovieSceneTimeController_ExternalClock	A timing manager that retrieves its time from an external clock source
	FMovieSceneTimeController_PlatformClock	A timing manager that retrieves its time from the platform clock
	FMovieSceneTimeController_RelativeTimecodeClock	A timing manager that retrieves its time relative to the Timecode clock
	FMovieSceneTimeController_Tick	A timing manager that accumulates delta times from a world
	FMovieSceneTimeController_TimecodeClock	A timing manager that retrieves its time from the Timecode clock
	FMovieSceneTrackDisplayOptions	Generic display options for any track
	FMovieSceneTrackEvalOptions	Generic evaluation options for any track
	FMovieSceneTrackEvaluationData
	FMovieSceneTrackEvaluationField
	FMovieSceneTrackEvaluationFieldEntry
	FMovieSceneTrackLabels	Structure for labels that can be assigned to movie scene tracks.
	FMovieSceneTrackPreCompileResult	Pre-compilation result
	FNewSpawnable	Struct used for defining a new spawnable type
	FNullMovieSceneSpawnRegister
	FOnMovieSceneSequencePlayerEvent
	FRelativeObjectBindingID	A binding ID whose target is resolved relative to the owner of this ID (either internal or external to that sequence through a parent or grandparent) Should be used for asignment to any serialized FMovieSceneObjectBindingID Represented by a local object binding ID and a parent index to which it is relative
	FSequenceVisitParams
	FSkeletalMeshEditorParams
	FSkeletalMeshRestoreState
	FStatelessPreAnimatedTokenProducer	Stateless pre-animated state token producer that simply calls a static function as the token
	FSubSequenceSpace
	FTrackInstancePropertyBindings	Manages bindings to keyed properties for a track instance.
	FTransformData	Stores information about a transform for the purpose of adding keys to a transform section
	IMovieSceneBindingOwnerInterface
	IMovieSceneExecutionToken	Base class for all execution tokens that are produced by evaluation templates
	IMovieSceneKeyProxy	Interface that can be implemented by any object that is used as a key editing proxy for a moviescene channel.
	IMovieSceneModule	The public interface of the MovieScene module
	IMovieSceneObjectSpawner	Interface used to extend spawn registers to support extra types
	IMovieScenePlaybackClient
	IMovieScenePlayer	Interface for movie scene players Provides information for playback of a movie scene
	IMovieScenePreAnimatedGlobalToken	Base class for all pre-animated state tokens that do not apply to UObjects.
	IMovieScenePreAnimatedGlobalTokenProducer	Type required for production of pre-animated state tokens.
	IMovieScenePreAnimatedToken	Base class for all pre-animated state tokens that apply to UObjects.
	IMovieScenePreAnimatedTokenProducer	Type required for production of pre-animated state tokens.
	IMovieSceneSequenceActor
	IMovieSceneSharedExecutionToken	Identifiyable and sortable execution token.
	INodeAndChannelMappings
	ISequenceVisitor
	MovieSceneHelpers
	TChannelValueHelper	Templated channel value accessor utility that get's sets a channel value and time
	TForwardingPreAnimatedTokenProducer	Templated pre-animated state token producer that forwards the object onto the templated type
	TimeHelpers
	TImplicitConversionFacade
	TMovieSceneEvaluationTree	Templated version of FMovieSceneEvaluationTree that is also able to associate arbitrary data with nodes
	TStatelessPreAnimatedTokenProducer	Templated stateless pre-animated state token producer that simply creates the templated type
	UMovieScene	Implements a movie scene asset.
	UMovieSceneBindingOverrides	A one-to-many definition of movie scene object binding IDs to overridden objects that should be bound to that binding.
	UMovieSceneBindingOwnerInterface	Interface used in the editor to provide contextual information about movie scene bindings
	UMovieSceneFolder	Represents a folder used for organizing objects in tracks in a movie scene.
	UMovieSceneKeyProxy
	UMovieSceneNameableTrack	Base class for movie scene tracks that can be renamed by the user.
	UMovieSceneNodeGroup	Structure that represents a group of nodes
	UMovieSceneNodeGroupCollection	Structure that represents a collection of NodeGroups
	UMovieScenePlaybackClient	Movie scene binding overrides interface
	UMovieSceneSection	Base class for movie scene sections
	UMovieSceneSequence	Abstract base class for movie scene animations (C++ version).
	UMovieSceneSequenceActor	Interface for sequence actors that are to be ticked by the tick manager.
	UMovieSceneSequencePlayer	Abstract class that provides consistent player behaviour for various animation players
	UMovieSceneSequenceTickManager	An automatically created global object that will manage all level sequence actors' updates.
	UMovieSceneSignedObject
	UMovieSceneTrack	Base class for a track in a Movie Scene
	UNodeAndChannelMappings

Typedefs

Name	Description
FMovieSceneOnChannelChanged	Delegates for use when some data in the MovieScene changes, WIP right now, hopefully will replace delegates on ISequencer and be used for moving towards a true MVC system
FMovieSceneSequenceIDRef
FMovieSceneSequenceLatentActionDelegate
FOnCreateMovieSceneObjectSpawner	A delegate which will create an object spawner
IMovieScenePreAnimatedGlobalTokenPtr
IMovieScenePreAnimatedTokenPtr

Enums

	Name	Description
	EMovieSceneChannelProxyType	Enumeration defining how a section's channel proxy behaves.
	EMovieSceneEvaluationType
	EMovieSceneKeyInterpolation
	EMovieSceneObjectBindingSpace	Enumeration specifying how a movie scene object binding ID relates to the sequence
	EMovieScenePlayerStatus::Type
	EMovieScenePositionType
	EMovieSceneSectionMovedResult	Result of having moved sections in the editor
	EMovieSceneSequenceFlags	Bitfield flags that define special behavior for any UMovieSceneSequence.
	EMovieSceneServerClientMask
	EMovieSceneTrackEasingSupportFlags	Returns what kind of section easing we support in the editor
	ESequencerKeyMode	Defines different modes for adding keyframes in sequencer.
	ESpawnOwnership
	ETrackSupport
	EUpdateClockSource	Enum used to define how to update to a particular time
	EUpdatePositionMethod	Enum used to define how to update to a particular time
	FFBXControlRigTypeProxyEnum	Sequencer Animation Track Support interface - this is required for animation track to workEnumeration specifying the control type

Functions

	Name	Description
void	ConvertInsertAndSort ( int32 IndexAt, FFrameNumber NewFrame, T& Value, TArray< FFrameNumber >& Times, TArray< T >& Values )	Set the value at the specified time and index into the arrays, sorted and converted to frame numbers We need this since some legacy channels and sections may not be sorted and we now expect time,value arrays to be sorted.
void	EmitLegacyOutOfBoundsError ( UObject* ErrorContext, FFrameRate InFrameRate, double InTime )
FFrameRate	GetLegacyConversionFrameRate()
FString	LexToString ( const TRange< FFrameNumber >& InRa... )
FString	LexToString ( const FMovieSceneSequenceID& Seque... )
void	MovieSceneClipboard::DefineExplicitConversion ( TFunction< To(const From&)> InConv... )
void	MovieSceneClipboard::DefineImplicitConversion()
FName	MovieSceneClipboard::GetKeyTypeName()
const FMovie...	MovieSceneSequenceID::Invalid ( - 1 )
const FMovie...	MovieSceneSequenceID::Root ( 0 )
constexpr bo...	operator! ( EMovieSceneSectionMovedResult E )
constexpr bo...	operator! ( EMovieSceneTrackEasingSupportFlags ... )
constexpr bo...	operator! ( EMovieSceneServerClientMask E )
constexpr bo...	operator! ( EMovieSceneSequenceFlags E )
constexpr EM...	operator& ( EMovieSceneServerClientMask Lhs, EMovieSceneServerClientMask Rhs )
constexpr EM...	operator& ( EMovieSceneSequenceFlags Lhs, EMovieSceneSequenceFlags Rhs )
constexpr EM...	operator& ( EMovieSceneSectionMovedResult Lhs, EMovieSceneSectionMovedResult Rhs )
constexpr EM...	operator& ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
EMovieSceneT...	operator&= ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
EMovieSceneS...	operator&= ( EMovieSceneSectionMovedResult& Lhs, EMovieSceneSectionMovedResult Rhs )
EMovieSceneS...	operator&= ( EMovieSceneServerClientMask& Lhs, EMovieSceneServerClientMask Rhs )
EMovieSceneS...	operator&= ( EMovieSceneSequenceFlags& Lhs, EMovieSceneSequenceFlags Rhs )
constexpr EM...	operator^ ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
constexpr EM...	operator^ ( EMovieSceneServerClientMask Lhs, EMovieSceneServerClientMask Rhs )
constexpr EM...	operator^ ( EMovieSceneSequenceFlags Lhs, EMovieSceneSequenceFlags Rhs )
constexpr EM...	operator^ ( EMovieSceneSectionMovedResult Lhs, EMovieSceneSectionMovedResult Rhs )
EMovieSceneS...	operator^= ( EMovieSceneSectionMovedResult& Lhs, EMovieSceneSectionMovedResult Rhs )
EMovieSceneT...	operator^= ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
EMovieSceneS...	operator^= ( EMovieSceneServerClientMask& Lhs, EMovieSceneServerClientMask Rhs )
EMovieSceneS...	operator^= ( EMovieSceneSequenceFlags& Lhs, EMovieSceneSequenceFlags Rhs )
constexpr EM...	operator\| ( EMovieSceneServerClientMask Lhs, EMovieSceneServerClientMask Rhs )
constexpr EM...	operator\| ( EMovieSceneSectionMovedResult Lhs, EMovieSceneSectionMovedResult Rhs )
constexpr EM...	operator\| ( EMovieSceneSequenceFlags Lhs, EMovieSceneSequenceFlags Rhs )
constexpr EM...	operator\| ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
EMovieSceneS...	operator\|= ( EMovieSceneServerClientMask& Lhs, EMovieSceneServerClientMask Rhs )
EMovieSceneS...	operator\|= ( EMovieSceneSectionMovedResult& Lhs, EMovieSceneSectionMovedResult Rhs )
EMovieSceneS...	operator\|= ( EMovieSceneSequenceFlags& Lhs, EMovieSceneSequenceFlags Rhs )
EMovieSceneT...	operator\|= ( EMovieSceneTrackEasingSupportFlags ..., EMovieSceneTrackEasingSupportFlags ... )
constexpr EM...	operator~ ( EMovieSceneServerClientMask E )
constexpr EM...	operator~ ( EMovieSceneSequenceFlags E )
constexpr EM...	operator~ ( EMovieSceneTrackEasingSupportFlags ... )
constexpr EM...	operator~ ( EMovieSceneSectionMovedResult E )
FFrameTime	UE::MovieScene::ClampToDiscreteRange ( FFrameTime InTime, const TRange< FFrameNumber >& InRa... )	Clamp the specified time to a range
TRange< FFra...	UE::MovieScene::ConvertToFrameTimeRange ( const TRange< FFrameNumber >& InRa... )	Convert a frame number range into a frame time range
TRange< T >	UE::MovieScene::DilateRange ( const TRange< T >& InRange, T LowerAmount, T UpperAmount )	Dilate the specified range by adding a specific size to the lower and upper bounds (if closed)
FFrameNumber	UE::MovieScene::DiscreteExclusiveUpper ( const TRangeBound< FFrameNumber >&... )	Return the first frame number that is not contained by the specified closed upper bound.
FFrameNumber	UE::MovieScene::DiscreteExclusiveUpper ( const TRange< FFrameNumber >& InRa... )	Return the first frame number not contained by the specified range.
FFrameNumber	UE::MovieScene::DiscreteInclusiveLower ( const TRange< FFrameNumber >& InRa... )	Return the first frame number included by the specified range.
FFrameNumber	UE::MovieScene::DiscreteInclusiveLower ( const TRangeBound< FFrameNumber >&... )	Return the first frame number included by the specified closed lower bound.
bool	UE::MovieScene::DiscreteRangeIsEmpty ( const TRange< FFrameNumber >& InRa... )	Check whether the specified range contains any integer frame numbers or not
int32	UE::MovieScene::DiscreteSize ( const TRange< FFrameNumber >& InRa... )	Calculate the size of a discrete frame range, taking into account inclusive/exclusive boundaries.
TRange< T >	UE::MovieScene::ExpandRange ( const TRange< T >& InRange, T Amount )	Expand the specified range by subtracting the specified amount from the lower bound, and adding it to the upper bound
bool	UE::MovieScene::IsEmptyOrZeroSize ( const TRange< FFrameNumber >& InRa... )	Return whether the given range is empty or zero frames wide
TRange< FFra...	UE::MovieScene::MakeDiscreteRange ( FFrameNumber MinInclusive, FFrameNumber MaxExclusive )	Make a new range that includes the given minimum and excludes the given maximum.
TRange< FFra...	UE::MovieScene::MakeDiscreteRangeFromLower ( const TRangeBound< FFrameNumber >&..., int32 DiscreteSize )	Make a new range using the specified lower bound, and a given size.
TRange< FFra...	UE::MovieScene::MakeDiscreteRangeFromUpper ( const TRangeBound< FFrameNumber >&..., int32 DiscreteSize )	Make a new range using the specified upper bound, and a given size.
TRange< T >	UE::MovieScene::TranslateRange ( const TRange< T >& InRange, T Amount )	Translate the specified range by adding the specified amount to both bounds.
FFrameNumber	UpgradeLegacyMovieSceneTime ( UObject* ErrorContext, FFrameRate InFrameRate, double InTime )

Variables

		Name	Description
	FMovieSceneBind...	OnNodeGroupCollectionChanged
	enum ESpawnOwne...	OnSignatureChanged
		STATCAT_Advanced

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

Take our survey

Dismiss