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

#include <MovieSceneSpawnRegister.h>

+ Inheritance diagram for FNullMovieSceneSpawnRegister:

Public Member Functions

virtual UObjectSpawnObject (FMovieSceneSpawnable &, FMovieSceneSequenceIDRef, TSharedRef< const FSharedPlaybackState >) override
 
virtual void DestroySpawnedObject (UObject &, UMovieSceneSpawnableBindingBase *CustomSpawnableBinding) override
 
- Public Member Functions inherited from FMovieSceneSpawnRegister
MOVIESCENE_API FMovieSceneSpawnRegister ()
 
MOVIESCENE_API FMovieSceneSpawnRegister (const FMovieSceneSpawnRegister &)
 
virtual MOVIESCENE_API ~FMovieSceneSpawnRegister ()
 
MOVIESCENE_API TWeakObjectPtr FindSpawnedObject (const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID, int BindingIndex) const
 
virtual MOVIESCENE_API UObjectSpawnObject (const FGuid &BindingId, UMovieScene &MovieScene, FMovieSceneSequenceIDRef Template, TSharedRef< const FSharedPlaybackState > SharedPlaybackState, int32 BindingIndex)
 
MOVIESCENE_API bool DestroySpawnedObject (const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState, int32 BindingIndex)
 
void DestroyObjectDirectly (UObject &InObject)
 
MOVIESCENE_API void DestroyObjectsByPredicate (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const TFunctionRef< bool(const FGuid &, ESpawnOwnership, FMovieSceneSequenceIDRef, int32)> &Predicate)
 
MOVIESCENE_API void ForgetExternallyOwnedSpawnedObjects (TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API void CleanUp (TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API void CleanUpSequence (FMovieSceneSequenceIDRef TemplateID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API void OnSequenceExpired (FMovieSceneSequenceIDRef TemplateID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
TWeakObjectPtr FindSpawnedObject (const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID) const
 
virtual UObjectSpawnObject (const FGuid &BindingId, UMovieScene &MovieScene, FMovieSceneSequenceIDRef Template, TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
bool DestroySpawnedObject (const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID, TSharedRef< const FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API UObjectSpawnObject (const FGuid &BindingId, UMovieScene &MovieScene, FMovieSceneSequenceIDRef Template, IMovieScenePlayer &Player)
 
MOVIESCENE_API bool DestroySpawnedObject (const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID, IMovieScenePlayer &Player)
 
MOVIESCENE_API void DestroyObjectsByPredicate (TSharedRef< const FSharedPlaybackState > SharedPlaybackState, const TFunctionRef< bool(const FGuid &, ESpawnOwnership, FMovieSceneSequenceIDRef)> &Predicate)
 
MOVIESCENE_API void DestroyObjectsByPredicate (IMovieScenePlayer &Player, const TFunctionRef< bool(const FGuid &, ESpawnOwnership, FMovieSceneSequenceIDRef)> &Predicate)
 
MOVIESCENE_API void ForgetExternallyOwnedSpawnedObjects (FMovieSceneEvaluationState &State, IMovieScenePlayer &Player)
 
MOVIESCENE_API void CleanUp (IMovieScenePlayer &Player)
 
MOVIESCENE_API void CleanUpSequence (FMovieSceneSequenceIDRef TemplateID, IMovieScenePlayer &Player)
 
MOVIESCENE_API void OnSequenceExpired (FMovieSceneSequenceIDRef TemplateID, IMovieScenePlayer &Player)
 
- Public Member Functions inherited from TSharedFromThis< FMovieSceneSpawnRegister >
TSharedRef< FMovieSceneSpawnRegister, Mode > AsShared ()
 
TSharedRef< FMovieSceneSpawnRegister const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FMovieSceneSpawnRegister, Mode > AsWeak ()
 
TWeakPtr< FMovieSceneSpawnRegister const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Additional Inherited Members

- Public Types inherited from FMovieSceneSpawnRegister
using FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState
 
- Protected Member Functions inherited from FMovieSceneSpawnRegister
virtual MOVIESCENE_API void PreDestroyObject (UObject &Object, const FGuid &BindingId, FMovieSceneSequenceIDRef TemplateID)
 
virtual void PreDestroyObject (UObject &Object, const FGuid &BindingId, int32 BindingIndex, FMovieSceneSequenceIDRef TemplateID)
 
virtual void DestroySpawnedObject (UObject &Object)
 
- Protected Member Functions inherited from TSharedFromThis< FMovieSceneSpawnRegister >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FMovieSceneSpawnRegister >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from FMovieSceneSpawnRegister
TMap< FMovieSceneSpawnRegisterKey, FSpawnedObjectRegister
 
bool bCleaningUp = false
 

Member Function Documentation

◆ DestroySpawnedObject()

virtual void FNullMovieSceneSpawnRegister::DestroySpawnedObject ( UObject Object,
UMovieSceneSpawnableBindingBase CustomSpawnableBinding 
)
inlineoverridevirtual

Destroy a specific previously spawned object

Parameters
ObjectThe object to destroy
CustomSpawnableBindingOptional custom spawnable binding to handle the destroy.

Implements FMovieSceneSpawnRegister.

◆ SpawnObject()

virtual UObject * FNullMovieSceneSpawnRegister::SpawnObject ( FMovieSceneSpawnable Spawnable,
FMovieSceneSequenceIDRef  TemplateID,
TSharedRef< const FSharedPlaybackState SharedPlaybackState 
)
inlineoverridevirtual

Spawn an object for the specified GUID, from the specified sequence instance.

Parameters
ObjectID of the object to spawn
TemplateIDIdentifier for the current template we're evaluating
PlayerMovie scene player that is ultimately responsible for spawning the object
Returns
the spawned object, or nullptr on failure

Implements FMovieSceneSpawnRegister.


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