IMovieSceneObjectSpawner Class Reference

#include <IMovieSceneObjectSpawner.h>

Inheritance diagram for IMovieSceneObjectSpawner:

Public Member Functions
virtual UClass *	GetSupportedTemplateType () const =0
virtual UObject *	SpawnObject (FMovieSceneSpawnable &Spawnable, FMovieSceneSequenceIDRef TemplateID, TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState)=0
virtual void	DestroySpawnedObject (UObject &Object)=0
virtual bool	IsEditor () const
virtual int32	GetSpawnerPriority () const
virtual	~IMovieSceneObjectSpawner ()

Detailed Description

Interface used to extend spawn registers to support extra types

Constructor & Destructor Documentation

~IMovieSceneObjectSpawner()

virtual IMovieSceneObjectSpawner::~IMovieSceneObjectSpawner ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

DestroySpawnedObject()

virtual void IMovieSceneObjectSpawner::DestroySpawnedObject ( UObject &  Object )

pure virtual

Destroy a specific previously spawned object

Parameters

Object

The object to destroy

Implemented in FLevelSequenceActorSpawner.

GetSpawnerPriority()

virtual int32 IMovieSceneObjectSpawner::GetSpawnerPriority ( ) const

inlinevirtual

Returns

Spawner priority in order to sort the list of the spawners. If several spawners match the template type, the one with the highest priority will be picked.

GetSupportedTemplateType()

virtual UClass * IMovieSceneObjectSpawner::GetSupportedTemplateType ( ) const

pure virtual

Returns the type of object we can spawn

Returns

the class of the object we support for spawning

Implemented in FLevelSequenceActorSpawner.

IsEditor()

virtual bool IMovieSceneObjectSpawner::IsEditor ( ) const

inlinevirtual

Returns

true if this spawner is used in the editor, or false if it is purely runtime. We use this to prioritize the use of editor spawners when in editor

SpawnObject()

virtual UObject * IMovieSceneObjectSpawner::SpawnObject ( FMovieSceneSpawnable &  Spawnable, FMovieSceneSequenceIDRef  TemplateID, TSharedRef< const UE::MovieScene::FSharedPlaybackState >  SharedPlaybackState  )

pure virtual

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

Parameters

Object	ID of the object to spawn
TemplateID	Identifier for the current template we're evaluating
Player	Movie scene player that is ultimately responsible for spawning the object

Returns

the spawned object, or nullptr on failure

Implemented in FLevelSequenceActorSpawner.

---

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

• Engine/Source/Runtime/MovieScene/Public/IMovieSceneObjectSpawner.h