UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UMovieScene Class Reference

#include <MovieScene.h>

+ Inheritance diagram for UMovieScene:

Public Member Functions

virtual MOVIESCENE_API void Serialize (FArchive &Ar) override
 
virtual MOVIESCENE_API bool IsPostLoadThreadSafe () const override
 
virtual MOVIESCENE_API void PostInitProperties () override
 
virtual MOVIESCENE_API void PostLoad () override
 
MOVIESCENE_API FGuid AddSpawnable (const FString &Name, UObject &ObjectTemplate)
 
MOVIESCENE_API void AddSpawnable (const FMovieSceneSpawnable &InNewSpawnable, const FMovieSceneBinding &InNewBinding)
 
MOVIESCENE_API bool RemoveSpawnable (const FGuid &Guid)
 
MOVIESCENE_API FMovieSceneSpawnableFindSpawnable (const TFunctionRef< bool(FMovieSceneSpawnable &)> &InPredicate)
 
MOVIESCENE_API FMovieSceneSpawnableFindSpawnable (const FGuid &Guid)
 
MOVIESCENE_API FMovieSceneSpawnableGetSpawnable (int32 Index)
 
MOVIESCENE_API int32 GetSpawnableCount () const
 
MOVIESCENE_API FGuid AddPossessable (const FString &Name, UClass *Class)
 
MOVIESCENE_API void AddPossessable (const FMovieScenePossessable &InNewPossessable, const FMovieSceneBinding &InNewBinding)
 
MOVIESCENE_API bool RemovePossessable (const FGuid &PossessableGuid)
 
MOVIESCENE_API bool ReplacePossessable (const FGuid &OldGuid, const FMovieScenePossessable &InNewPosessable)
 
MOVIESCENE_API struct FMovieScenePossessableFindPossessable (const FGuid &Guid)
 
MOVIESCENE_API FMovieScenePossessableFindPossessable (const TFunctionRef< bool(FMovieScenePossessable &)> &InPredicate)
 
MOVIESCENE_API FMovieScenePossessableGetPossessable (const int32 Index)
 
MOVIESCENE_API int32 GetPossessableCount () const
 
MOVIESCENE_API UMovieSceneTrackAddTrack (TSubclassOf< UMovieSceneTrack > TrackClass, const FGuid &ObjectGuid)
 
MOVIESCENE_API bool AddGivenTrack (UMovieSceneTrack *InTrack, const FGuid &ObjectGuid)
 
template<typename TrackClass >
TrackClass * AddTrack (const FGuid &ObjectGuid)
 
MOVIESCENE_API UMovieSceneTrackFindTrack (TSubclassOf< UMovieSceneTrack > TrackClass, const FGuid &ObjectGuid, const FName &TrackName=NAME_None) const
 
template<typename TrackClass >
TrackClass * FindTrack (const FGuid &ObjectGuid, const FName &TrackName=NAME_None) const
 
MOVIESCENE_API TArray< UMovieSceneTrack * > FindTracks (TSubclassOf< UMovieSceneTrack > TrackClass, const FGuid &ObjectGuid, const FName &TrackName=NAME_None) const
 
MOVIESCENE_API bool RemoveTrack (UMovieSceneTrack &Track)
 
MOVIESCENE_API bool FindTrackBinding (const UMovieSceneTrack &InTrack, FGuid &OutGuid) const
 
MOVIESCENE_API UMovieSceneTrackAddTrack (TSubclassOf< UMovieSceneTrack > TrackClass)
 
template<typename TrackClass >
TrackClass * AddTrack ()
 
MOVIESCENE_API bool AddGivenTrack (UMovieSceneTrack *InTrack)
 
MOVIESCENE_API UMovieSceneTrackFindTrack (TSubclassOf< UMovieSceneTrack > TrackClass) const
 
template<typename TrackClass >
TrackClass * FindTrack () const
 
const TArray< UMovieSceneTrack * > & GetTracks () const
 
MOVIESCENE_API bool ContainsTrack (const UMovieSceneTrack &Track) const
 
MOVIESCENE_API void MoveBindingContents (const FGuid &SourceBindingId, const FGuid &DestinationBindingId)
 
MOVIESCENE_API FMovieSceneBindingFindBinding (const FGuid &ForGuid)
 
MOVIESCENE_API const FMovieSceneBindingFindBinding (const FGuid &ForGuid) const
 
MOVIESCENE_API UMovieSceneTrackAddCameraCutTrack (TSubclassOf< UMovieSceneTrack > TrackClass)
 
MOVIESCENE_API UMovieSceneTrackGetCameraCutTrack () const
 
MOVIESCENE_API void RemoveCameraCutTrack ()
 
MOVIESCENE_API void SetCameraCutTrack (UMovieSceneTrack *Track)
 
MOVIESCENE_API TArray< UMovieSceneSection * > GetAllSections () const
 
const TArray< FMovieSceneBinding > & GetBindings () const
 
TArray< FMovieSceneBinding > & GetBindings ()
 
TRange< FFrameNumberGetSelectionRange () const
 
MOVIESCENE_API FText GetObjectDisplayName (const FGuid &ObjectId) const
 
TRange< FFrameNumberGetPlaybackRange () const
 
FFrameRate GetTickResolution () const
 
MOVIESCENE_API void SetTickResolutionDirectly (FFrameRate InTickResolution)
 
FFrameRate GetDisplayRate () const
 
void SetDisplayRate (FFrameRate InDisplayRate)
 
EMovieSceneEvaluationType GetEvaluationType () const
 
void SetEvaluationType (EMovieSceneEvaluationType InNewEvaluationType)
 
EUpdateClockSource GetClockSource () const
 
UMovieSceneClockGetCustomClock () const
 
template<typename T >
T * GetCustomClockAs () const
 
MOVIESCENE_API TSharedPtr< FMovieSceneTimeControllerMakeCustomTimeController (UObject *PlaybackContext)
 
MOVIESCENE_API void SetClockSource (EUpdateClockSource InNewClockSource)
 
MOVIESCENE_API void SetClockSource (UObject *InNewClockSource)
 
MOVIESCENE_API void SetCustomClock (UMovieSceneClock *InNewClockSource)
 
MOVIESCENE_API FMovieSceneTimecodeSource GetEarliestTimecodeSource () const
 
MOVIESCENE_API void ReplaceBinding (const FGuid &OldGuid, const FGuid &NewGuid, const FString &Name)
 
MOVIESCENE_API void ReplaceBinding (const FGuid &BindingToReplaceGuid, const FMovieSceneBinding &NewBinding)
 
MOVIESCENE_API void SetPlaybackRange (FFrameNumber Start, int32 Duration, bool bAlwaysMarkDirty=true)
 
MOVIESCENE_API void SetPlaybackRange (const TRange< FFrameNumber > &NewRange, bool bAlwaysMarkDirty=true)
 
MOVIESCENE_API void SetWorkingRange (double Start, double End)
 
MOVIESCENE_API void SetViewRange (double Start, double End)
 
const TArray< FMovieSceneMarkedFrame > & GetMarkedFrames () const
 
MOVIESCENE_API void SetMarkedFrame (int32 InMarkIndex, FFrameNumber InFrameNumber)
 
MOVIESCENE_API int32 AddMarkedFrame (const FMovieSceneMarkedFrame &InMarkedFrame)
 
MOVIESCENE_API void DeleteMarkedFrame (int32 DeleteIndex)
 
MOVIESCENE_API void DeleteMarkedFrames ()
 
MOVIESCENE_API void SortMarkedFrames ()
 
MOVIESCENE_API int32 FindMarkedFrameByLabel (const FString &InLabel) const
 
MOVIESCENE_API int32 FindMarkedFrameByFrameNumber (FFrameNumber InFrameNumber) const
 
MOVIESCENE_API int32 FindNextMarkedFrame (FFrameNumber InFrameNumber, bool bForward)
 
const TMap< FName, FMovieSceneObjectBindingIDs > & AllTaggedBindings () const
 
MOVIESCENE_API void AddNewBindingTag (const FName &NewTag)
 
MOVIESCENE_API void TagBinding (const FName &NewTag, const UE::MovieScene::FFixedObjectBindingID &BindingToTag)
 
MOVIESCENE_API void UntagBinding (const FName &Tag, const UE::MovieScene::FFixedObjectBindingID &Binding)
 
MOVIESCENE_API void RemoveTag (const FName &TagToRemove)
 
void AddGeneratedCondition (UMovieSceneGroupCondition *InGeneratedCondition)
 
void ResetGeneratedConditions ()
 
- Public Member Functions inherited from UMovieSceneDecorationContainerObject
UObjectFindDecoration (const TSubclassOf< UObject > &InClass) const
 
MOVIESCENE_API void AddDecoration (UObject *InDecoration)
 
MOVIESCENE_API UObjectGetOrCreateDecoration (const TSubclassOf< UObject > &InClass)
 
MOVIESCENE_API void RemoveDecoration (const TSubclassOf< UObject > &InClass)
 
TArrayView< const TObjectPtr< UObject > > GetDecorations () const
 
template<typename DecorationType >
DecorationTypeFindDecoration () const
 
template<typename DecorationType >
DecorationTypeGetOrCreateDecoration ()
 
template<typename DecorationType >
void RemoveDecoration ()
 
void GetCompatibleUserDecorations (TSet< UClass * > &OutClasses) const
 
- Public Member Functions inherited from UMovieSceneSignedObject
MOVIESCENE_API UMovieSceneSignedObject (const FObjectInitializer &Init)
 
MOVIESCENE_API void MarkAsChanged ()
 
const FGuidGetSignature () const
 
MOVIESCENE_API void BroadcastChanged ()
 
FOnSignatureChangedOnSignatureChanged ()
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Public Attributes

UE::MovieScene::TDataEventContainer< UE::MovieScene::ISequenceDataEventHandlerEventHandlers
 
- Public Attributes inherited from UMovieSceneSignedObject
UE::MovieScene::TDataEventContainer< UE::MovieScene::ISignedObjectEventHandlerEventHandlers
 

Protected Member Functions

MOVIESCENE_API void RemoveBinding (const FGuid &Guid)
 
int32 IndexOfBinding (const FGuid &ForGuid) const
 
int32 IndexOfSpawnable (const FGuid &ForGuid) const
 
int32 IndexOfPossessable (const FGuid &ForGuid) const
 
virtual MOVIESCENE_API void PreSave (FObjectPreSaveContext ObjectSaveContext) override
 
virtual MOVIESCENE_API void OnDecorationAdded (UObject *NewDecoration) override
 
virtual MOVIESCENE_API void OnDecorationRemoved (UObject *NewDecoration) override
 
MOVIESCENE_API void UpgradeTimeRanges ()
 
- Protected Member Functions inherited from UMovieSceneDecorationContainerObject
virtual void GetCompatibleUserDecorationsImpl (TSet< UClass * > &OutClasses) const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UMovieSceneSignedObject
static MOVIESCENE_API TWeakPtr< UE::MovieScene::IDeferredSignedObjectChangeHandlerGetDeferredHandler ()
 
static MOVIESCENE_API void SetDeferredHandler (TWeakPtr< UE::MovieScene::IDeferredSignedObjectChangeHandler > &&InHandler)
 
static MOVIESCENE_API void AddFlushSignal (TWeakPtr< UE::MovieScene::IDeferredSignedObjectFlushSignal > Signal)
 
static MOVIESCENE_API void ResetImplicitScopedModifyDefer ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Protected Attributes inherited from UMovieSceneDecorationContainerObject
FMovieSceneDecorationContainer Decorations
 

Detailed Description

Implements a movie scene asset.

Member Function Documentation

◆ AddCameraCutTrack()

UMovieSceneTrack * UMovieScene::AddCameraCutTrack ( TSubclassOf< UMovieSceneTrack TrackClass)

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.

Parameters
TrackClassThe camera cut track class type
Returns
The created camera cut track

◆ AddGeneratedCondition()

void UMovieScene::AddGeneratedCondition ( UMovieSceneGroupCondition InGeneratedCondition)
inline

◆ AddGivenTrack() [1/2]

bool UMovieScene::AddGivenTrack ( UMovieSceneTrack InTrack)

Adds a given track as a track

Parameters
InTrackThe track to add.
See also
FindTrack, RemoveTrack
Returns
true if the track is successfully added, false otherwise.

◆ AddGivenTrack() [2/2]

bool UMovieScene::AddGivenTrack ( UMovieSceneTrack InTrack,
const FGuid ObjectGuid 
)

Adds a given track.

Parameters
InTrackThe track to add.
ObjectGuidThe runtime object guid that the type should bind to
See also
FindTrack, RemoveTrack
Returns
true if the track is successfully added, false otherwise.

◆ AddMarkedFrame()

int32 UMovieScene::AddMarkedFrame ( const FMovieSceneMarkedFrame InMarkedFrame)

◆ AddNewBindingTag()

void UMovieScene::AddNewBindingTag ( const FName NewTag)

◆ AddPossessable() [1/2]

void UMovieScene::AddPossessable ( const FMovieScenePossessable InNewPossessable,
const FMovieSceneBinding InNewBinding 
)

◆ AddPossessable() [2/2]

FGuid UMovieScene::AddPossessable ( const FString &  Name,
UClass Class 
)

Adds a possessable to this movie scene.

Parameters
NameName of the possessable.
ClassThe class of object that will be possessed.
Returns
Guid of the newly-added possessable.

◆ AddSpawnable() [1/2]

void UMovieScene::AddSpawnable ( const FMovieSceneSpawnable InNewSpawnable,
const FMovieSceneBinding InNewBinding 
)

◆ AddSpawnable() [2/2]

FGuid UMovieScene::AddSpawnable ( const FString &  Name,
UObject ObjectTemplate 
)

Add a spawnable to this movie scene's list of owned blueprints.

These objects are stored as "inners" of the MovieScene.

Parameters
NameName of the spawnable.
ObjectTemplateThe object template to use for the spawnable
Returns
Guid of the newly-added spawnable.

◆ AddTrack() [1/4]

template<typename TrackClass >
TrackClass * UMovieScene::AddTrack ( )
inline

Adds a track.

Note: The type should not already exist.

Parameters
TrackClassThe class of the track to create
TypeThe newly created type
See also
FindTrack, GetTracks, IsTrack, RemoveTrack

◆ AddTrack() [2/4]

template<typename TrackClass >
TrackClass * UMovieScene::AddTrack ( const FGuid ObjectGuid)
inline

Adds a track.

Note: The type should not already exist.

Parameters
TrackClassThe class of the track to create.
ObjectGuidThe runtime object guid that the type should bind to.
TypeThe newly created type.
See also
FindTrack, RemoveTrack

◆ AddTrack() [3/4]

UMovieSceneTrack * UMovieScene::AddTrack ( TSubclassOf< UMovieSceneTrack TrackClass)

Adds a track.

Note: The type should not already exist.

Parameters
TrackClassThe class of the track to create
TypeThe newly created type
See also
FindTrack, GetTracks, IsTrack, RemoveTrack

◆ AddTrack() [4/4]

UMovieSceneTrack * UMovieScene::AddTrack ( TSubclassOf< UMovieSceneTrack TrackClass,
const FGuid ObjectGuid 
)

Adds a track.

Note: The type should not already exist.

Parameters
TrackClassThe class of the track to create.
ObjectGuidThe runtime object guid that the type should bind to.
TypeThe newly created type.
See also
FindTrack, RemoveTrack

◆ AllTaggedBindings()

const TMap< FName, FMovieSceneObjectBindingIDs > & UMovieScene::AllTaggedBindings ( ) const
inline

◆ ContainsTrack()

bool UMovieScene::ContainsTrack ( const UMovieSceneTrack Track) const

Check whether the specified track is a track in this movie scene.

Returns
true if the track is a track, false otherwise.
See also
AddTrack, FindTrack, GetTracks, RemoveTrack

◆ DeleteMarkedFrame()

void UMovieScene::DeleteMarkedFrame ( int32  DeleteIndex)

◆ DeleteMarkedFrames()

void UMovieScene::DeleteMarkedFrames ( )

◆ FindBinding() [1/2]

FMovieSceneBinding * UMovieScene::FindBinding ( const FGuid ForGuid)

Tries to find an FMovieSceneBinding for the specified Guid.

Parameters
ForGuidThe binding's Guid to look for.
Returns
Pointer to the binding, otherwise nullptr.

◆ FindBinding() [2/2]

const FMovieSceneBinding * UMovieScene::FindBinding ( const FGuid ForGuid) const

Tries to find an FMovieSceneBinding for the specified Guid.

Parameters
ForGuidThe binding's Guid to look for.
Returns
Pointer to the binding, otherwise nullptr.

◆ FindMarkedFrameByFrameNumber()

int32 UMovieScene::FindMarkedFrameByFrameNumber ( FFrameNumber  InFrameNumber) const

◆ FindMarkedFrameByLabel()

int32 UMovieScene::FindMarkedFrameByLabel ( const FString &  InLabel) const

◆ FindNextMarkedFrame()

int32 UMovieScene::FindNextMarkedFrame ( FFrameNumber  InFrameNumber,
bool  bForward 
)

◆ FindPossessable() [1/2]

FMovieScenePossessable * UMovieScene::FindPossessable ( const FGuid Guid)

Tries to locate a possessable in this MovieScene for the specified possessable GUID.

Parameters
GuidThe possessable guid to search for.
Returns
Possessable object that was found (or nullptr if not found).

◆ FindPossessable() [2/2]

FMovieScenePossessable * UMovieScene::FindPossessable ( const TFunctionRef< bool(FMovieScenePossessable &)> &  InPredicate)

Attempt to find a possessable using some custom prdeicate

Parameters
InPredicateA predicate to test each possessable against
Returns
Possessable object that was found (or nullptr if not found).

◆ FindSpawnable() [1/2]

FMovieSceneSpawnable * UMovieScene::FindSpawnable ( const FGuid Guid)

Tries to locate a spawnable in this MovieScene for the specified spawnable GUID.

Parameters
GuidThe spawnable guid to search for.
Returns
Spawnable object that was found (or nullptr if not found).

◆ FindSpawnable() [2/2]

FMovieSceneSpawnable * UMovieScene::FindSpawnable ( const TFunctionRef< bool(FMovieSceneSpawnable &)> &  InPredicate)

Attempt to find a spawnable using some custom predicate

Parameters
InPredicateA predicate to test each spawnable against
Returns
Spawnable object that was found (or nullptr if not found).

◆ FindTrack() [1/4]

template<typename TrackClass >
TrackClass * UMovieScene::FindTrack ( ) const
inline

Finds a track (one not bound to a runtime objects).

Parameters
TrackClassThe class of the track to find.
Returns
The found track or nullptr if one does not exist.
See also
AddTrack, GetTracks, IsTrack, RemoveTrack

◆ FindTrack() [2/4]

template<typename TrackClass >
TrackClass * UMovieScene::FindTrack ( const FGuid ObjectGuid,
const FName TrackName = NAME_None 
) const
inline

Finds a track.

Parameters
TrackClassThe class of the track to find.
ObjectGuidThe runtime object guid that the track is bound to.
TrackNameThe name of the track to differentiate the one we are searching for from other tracks of the same class (optional).
Returns
The found track or nullptr if one does not exist.
See also
AddTrack, RemoveTrack, FindTracks

◆ FindTrack() [3/4]

UMovieSceneTrack * UMovieScene::FindTrack ( TSubclassOf< UMovieSceneTrack TrackClass) const

Finds a track (one not bound to a runtime objects).

Parameters
TrackClassThe class of the track to find.
Returns
The found track or nullptr if one does not exist.
See also
AddTrack, GetTracks, IsTrack, RemoveTrack

◆ FindTrack() [4/4]

UMovieSceneTrack * UMovieScene::FindTrack ( TSubclassOf< UMovieSceneTrack TrackClass,
const FGuid ObjectGuid,
const FName TrackName = NAME_None 
) const

Finds a track.

Parameters
TrackClassThe class of the track to find.
ObjectGuidThe runtime object guid that the track is bound to.
TrackNameThe name of the track to differentiate the one we are searching for from other tracks of the same class (optional).
Returns
The found track or nullptr if one does not exist.
See also
AddTrack, RemoveTrack, FindTracks

◆ FindTrackBinding()

bool UMovieScene::FindTrackBinding ( const UMovieSceneTrack InTrack,
FGuid OutGuid 
) const

Find a track binding Guid from a UMovieSceneTrack

Parameters
InTrackThe track to find the binding for.
OutGuidThe binding's Guid if one was found.
Returns
true if a binding was found for this track.

◆ FindTracks()

TArray< UMovieSceneTrack * > UMovieScene::FindTracks ( TSubclassOf< UMovieSceneTrack TrackClass,
const FGuid ObjectGuid,
const FName TrackName = NAME_None 
) const

Find all tracks of a given class.

Parameters
TrackClassThe class of the track to find.
ObjectGuidThe runtime object guid that the track is bound to.
TrackNameThe name of the track to differentiate the one we are searching for from other tracks of the same class (optional).
Returns
The found tracks or an empty array if none exist
See also
AddTrack, RemoveTrack, FindTrack

◆ GetAllSections()

TArray< UMovieSceneSection * > UMovieScene::GetAllSections ( ) const

Returns all sections and their associated binding data.

Returns
A list of sections with object bindings and names.

◆ GetBindings() [1/2]

TArray< FMovieSceneBinding > & UMovieScene::GetBindings ( )
inline

◆ GetBindings() [2/2]

const TArray< FMovieSceneBinding > & UMovieScene::GetBindings ( ) const
inline
Returns
All object bindings.

◆ GetCameraCutTrack()

UMovieSceneTrack * UMovieScene::GetCameraCutTrack ( ) const
Returns
The camera cut track if it exists.

◆ GetClockSource()

EUpdateClockSource UMovieScene::GetClockSource ( ) const
inline

retrieve the clock source to be used for this moviescene

◆ GetCustomClock()

UMovieSceneClock * UMovieScene::GetCustomClock ( ) const
inline

◆ GetCustomClockAs()

template<typename T >
T * UMovieScene::GetCustomClockAs ( ) const
inline

◆ GetDisplayRate()

FFrameRate UMovieScene::GetDisplayRate ( ) const
inline

Retrieve the display frame rate for this data, in which frame numbers should be displayed on UI, and interacted with in movie scene players

◆ GetEarliestTimecodeSource()

FMovieSceneTimecodeSource UMovieScene::GetEarliestTimecodeSource ( ) const

Get the earliest timecode source out of all of the movie scene sections contained within this movie scene.

◆ GetEvaluationType()

EMovieSceneEvaluationType UMovieScene::GetEvaluationType ( ) const
inline

Retrieve a value signifying how to evaluate this movie scene data

◆ GetMarkedFrames()

const TArray< FMovieSceneMarkedFrame > & UMovieScene::GetMarkedFrames ( ) const
inline

◆ GetObjectDisplayName()

FText UMovieScene::GetObjectDisplayName ( const FGuid ObjectId) const

Get the display name of the object with the specified identifier.

Parameters
ObjectIdThe object identifier.
Returns
The object's display name.

◆ GetPlaybackRange()

TRange< FFrameNumber > UMovieScene::GetPlaybackRange ( ) const
inline

Get the playback time range of this movie scene, relative to its 0-time offset.

◆ GetPossessable()

FMovieScenePossessable & UMovieScene::GetPossessable ( const int32  Index)

Grabs a reference to a specific possessable by index.

Parameters
Indexof possessable to return.
Returns
Returns the specified possessable by index.

◆ GetPossessableCount()

int32 UMovieScene::GetPossessableCount ( ) const

Get the number of possessable objects in this scene.

Returns
Possessable object count.

◆ GetSelectionRange()

TRange< FFrameNumber > UMovieScene::GetSelectionRange ( ) const
inline

Get the current selection range.

◆ GetSpawnable()

FMovieSceneSpawnable & UMovieScene::GetSpawnable ( int32  Index)

Grabs a reference to a specific spawnable by index.

Parameters
Indexof spawnable to return. Must be between 0 and GetSpawnableCount()
Returns
Returns the specified spawnable by index.

◆ GetSpawnableCount()

int32 UMovieScene::GetSpawnableCount ( ) const

Get the number of spawnable objects in this scene.

Returns
Spawnable object count.

◆ GetTickResolution()

FFrameRate UMovieScene::GetTickResolution ( ) const
inline

Retrieve the tick resolution at which all frame numbers within this movie scene are defined

◆ GetTracks()

const TArray< UMovieSceneTrack * > & UMovieScene::GetTracks ( ) const
inline

Get all tracks.

Returns
Track collection.
See also
AddTrack, FindTrack, IsTrack, RemoveTrack

◆ IndexOfBinding()

int32 UMovieScene::IndexOfBinding ( const FGuid ForGuid) const
protected

Tries to find an FMovieSceneBinding for the specified Guid.

Parameters
ForGuidThe binding's Guid to look for.
Returns
Index of the binding in ObjectBindings array, otherwise INDEX_NONE.

◆ IndexOfPossessable()

int32 UMovieScene::IndexOfPossessable ( const FGuid ForGuid) const
protected

Tries to find an FMovieScenePossessable for the specified Guid.

Parameters
ForGuidThe possessable's Guid to look for.
Returns
Index of the binding in Possessables array, otherwise INDEX_NONE.

◆ IndexOfSpawnable()

int32 UMovieScene::IndexOfSpawnable ( const FGuid ForGuid) const
protected

Tries to find an FMovieSceneSpawnable for the specified Guid.

Parameters
ForGuidThe spawnable's Guid to look for.
Returns
Index of the binding in Spawnables array, otherwise INDEX_NONE.

◆ IsPostLoadThreadSafe()

bool UMovieScene::IsPostLoadThreadSafe ( ) const
overridevirtual

Called during async load to determine if PostLoad can be called on the loading thread.

Returns
true if this object's PostLoad is thread safe

Reimplemented from UObject.

◆ MakeCustomTimeController()

TSharedPtr< FMovieSceneTimeController > UMovieScene::MakeCustomTimeController ( UObject PlaybackContext)

Retrieve a time controller from this sequence instance, if the clock source is set to custom

◆ MoveBindingContents()

void UMovieScene::MoveBindingContents ( const FGuid SourceBindingId,
const FGuid DestinationBindingId 
)

Move all the contents (tracks, child bindings) of the specified binding ID onto another

Parameters
SourceBindingIdThe identifier of the binding ID to move all tracks and children from
DestinationBindingIdThe identifier of the binding ID to move the contents to

◆ OnDecorationAdded()

void UMovieScene::OnDecorationAdded ( UObject NewDecoration)
overrideprotectedvirtual

◆ OnDecorationRemoved()

void UMovieScene::OnDecorationRemoved ( UObject NewDecoration)
overrideprotectedvirtual

◆ PostInitProperties()

void UMovieScene::PostInitProperties ( )
overridevirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UMovieSceneSignedObject.

◆ PostLoad()

void UMovieScene::PostLoad ( )
overridevirtual

Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

Reimplemented from UMovieSceneSignedObject.

◆ PreSave()

void UMovieScene::PreSave ( FObjectPreSaveContext  ObjectSaveContext)
overrideprotectedvirtual

Called before this object is being deserialized.

Reimplemented from UObject.

◆ RemoveBinding()

void UMovieScene::RemoveBinding ( const FGuid Guid)
protected

Removes animation data bound to a GUID.

Parameters
GuidThe guid bound to animation data to remove

◆ RemoveCameraCutTrack()

void UMovieScene::RemoveCameraCutTrack ( )

Removes the camera cut track if it exists.

◆ RemovePossessable()

bool UMovieScene::RemovePossessable ( const FGuid PossessableGuid)

Removes a possessable from this movie scene.

Parameters
PossessableGuidGuid of possessable to remove.

◆ RemoveSpawnable()

bool UMovieScene::RemoveSpawnable ( const FGuid Guid)

Removes a spawnable from this movie scene.

Parameters
GuidThe guid of a spawnable to find and remove.
Returns
true if anything was removed.

◆ RemoveTag()

void UMovieScene::RemoveTag ( const FName TagToRemove)

◆ RemoveTrack()

bool UMovieScene::RemoveTrack ( UMovieSceneTrack Track)

Removes a track.

Parameters
TrackThe track to remove.
Returns
true if anything was removed.
See also
AddTrack, FindTrack

◆ ReplaceBinding() [1/2]

void UMovieScene::ReplaceBinding ( const FGuid BindingToReplaceGuid,
const FMovieSceneBinding NewBinding 
)

◆ ReplaceBinding() [2/2]

void UMovieScene::ReplaceBinding ( const FGuid OldGuid,
const FGuid NewGuid,
const FString &  Name 
)

◆ ReplacePossessable()

bool UMovieScene::ReplacePossessable ( const FGuid OldGuid,
const FMovieScenePossessable InNewPosessable 
)

◆ ResetGeneratedConditions()

void UMovieScene::ResetGeneratedConditions ( )
inline

◆ Serialize()

void UMovieScene::Serialize ( FArchive Ar)
overridevirtual

~ UObject implementation

Reimplemented from UMovieSceneDecorationContainerObject.

◆ SetCameraCutTrack()

void UMovieScene::SetCameraCutTrack ( UMovieSceneTrack Track)

◆ SetClockSource() [1/2]

void UMovieScene::SetClockSource ( EUpdateClockSource  InNewClockSource)

Assign the clock source to be used for this moviescene

◆ SetClockSource() [2/2]

void UMovieScene::SetClockSource ( UObject InNewClockSource)

Assign the clock source to be used for this moviescene

◆ SetCustomClock()

void UMovieScene::SetCustomClock ( UMovieSceneClock InNewClockSource)

◆ SetDisplayRate()

void UMovieScene::SetDisplayRate ( FFrameRate  InDisplayRate)
inline

Set the play rate for this movie scene

◆ SetEvaluationType()

void UMovieScene::SetEvaluationType ( EMovieSceneEvaluationType  InNewEvaluationType)
inline

Assign a value signifying how to evaluate this movie scene data

◆ SetMarkedFrame()

void UMovieScene::SetMarkedFrame ( int32  InMarkIndex,
FFrameNumber  InFrameNumber 
)

◆ SetPlaybackRange() [1/2]

void UMovieScene::SetPlaybackRange ( const TRange< FFrameNumber > &  NewRange,
bool  bAlwaysMarkDirty = true 
)

Set the playback range for this movie scene

Parameters
RangeThe new playback range. Must not have any open bounds (ie must be a finite range)
bAlwaysMarkDirtyWhether to always mark the playback range dirty when changing it. In the case where the playback range is dynamic and based on section bounds, the playback range doesn't need to be dirtied when set

◆ SetPlaybackRange() [2/2]

void UMovieScene::SetPlaybackRange ( FFrameNumber  Start,
int32  Duration,
bool  bAlwaysMarkDirty = true 
)

Set the start and end playback positions (playback range) for this movie scene

Parameters
StartThe offset from 0-time to start playback of this movie scene
DurationThe number of frames the movie scene should play for
bAlwaysMarkDirtyWhether to always mark the playback range dirty when changing it. In the case where the playback range is dynamic and based on section bounds, the playback range doesn't need to be dirtied when set

◆ SetTickResolutionDirectly()

void UMovieScene::SetTickResolutionDirectly ( FFrameRate  InTickResolution)

Directly set the tick resolution for this movie scene without applying any conversion whatsoever, or modifying the data

◆ SetViewRange()

void UMovieScene::SetViewRange ( double  Start,
double  End 
)

Set the start and end view range (inner) for this movie scene

Parameters
StartThe offset from 0-time to view this movie scene
EndThe offset from 0-time to view this movie scene

◆ SetWorkingRange()

void UMovieScene::SetWorkingRange ( double  Start,
double  End 
)

Set the start and end working range (outer) for this movie scene

Parameters
StartThe offset from 0-time to view this movie scene.
EndThe offset from 0-time to view this movie scene

◆ SortMarkedFrames()

void UMovieScene::SortMarkedFrames ( )

◆ TagBinding()

void UMovieScene::TagBinding ( const FName NewTag,
const UE::MovieScene::FFixedObjectBindingID BindingToTag 
)

◆ UntagBinding()

void UMovieScene::UntagBinding ( const FName Tag,
const UE::MovieScene::FFixedObjectBindingID Binding 
)

◆ UpgradeTimeRanges()

void UMovieScene::UpgradeTimeRanges ( )
protected

Perform legacy upgrade of time ranges

Member Data Documentation

◆ EventHandlers


The documentation for this class was generated from the following files: