1. Epic GamesDeveloper
  3. FMovieSceneSpawnRegister

FMovieSceneSpawnRegister

Class responsible for managing spawnables in a movie scene

API > API/Runtime > API/Runtime/MovieScene

Inheritance Hierarchy

References

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

Syntax

class FMovieSceneSpawnRegister : public TSharedFromThis< FMovieSceneSpawnRegister >

Remarks

Class responsible for managing spawnables in a movie scene

Variables

  Type Name Description
Protected variable bool bCleaningUp True when cleaning ourselves up.
Protected variable TMap< FMovieSceneSpawnRegisterKey, FSpawnedObject > Register Register of spawned objects

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Virtual Const bool Check whether the specified Spawnable can become a Possessable.
Public function Virtual Const bool

CanSpawnObject ( UClass* InClass
)

 Whether this class is supported as a spawnable
Public function void Called to indiscriminately clean up any spawned objects
Public function void

CleanUpSequence ( FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

 Called to clean up any non-externally owned spawnables that were spawned from the specified instance
Public function Virtual TValueOrError< FNewSpawnable, FText >

CreateNewSpawnableType ( UObject& SourceObject,
UMovieScene& OwnerMovieScene,
UActorFactory* ActorFactory
)

 Create a new spawnable type from the given source object
Public function void Destroy a specific previously spawned object, where its binding ID and sequence ID is not known.
Public function void

DestroyObjectsByPredicate ( IMovieScenePlayer& Player,
const TFunctionRef< bool(const FGuid&, ESpawnOwnership, FMovieSceneSequenceIDRef)>& Predicate
)

 Destroy spawned objects using a custom predicate
Public function bool

DestroySpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

 Destroy a specific previously spawned object
Protected function void Destroy a specific previously spawned object
Public function Const TWeakObjectPtr

FindSpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID
)

 Attempt to find a previously spawned object represented by the specified object and template IDs
Public function void Purge any memory of any objects that are considered externally owned
Public function Virtual void Called to handle cleanup of objects when we convert a possessable to a spawnable object
Public function void

OnSequenceExpired ( FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

 Called when the current time has moved beyond the specified sequence's play range
Protected function Virtual void

PreDestroyObject ( UObject& Object,
const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID
)

 Called right before a spawned object with the specified ID and template ID is destroyed
Public function Virtual void

SaveDefaultSpawnableState ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

 Called to save the default state of the specified spawnable
Public function Virtual void

SetupDefaultsForSpawnable ( UObject* SpawnedObject,
const FGuid& Guid,
const TOptional< FTransformData >& TransformData,
TSharedRef< ISequencer > Sequencer,
USequencerSettings* Settings
)

 Setup a new spawnable object with some default tracks and keys
Protected function UObject *

SpawnObject ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

 Spawn an object for the specified GUID, from the specified sequence instance.
Public function UObject *

SpawnObject ( const FGuid& BindingId,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef Template,
IMovieScenePlayer& Player
)

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

Classes

  Type Name Description
Protected struct FMovieSceneSpawnRegisterKey Helper key type for mapping a guid and sequence instance to a specific value  
Protected struct FSpawnedObject Structure holding information pertaining to a spawned object  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page