FMovieSceneSpawnable Struct Reference

#include <MovieSceneSpawnable.h>

Public Member Functions
	FMovieSceneSpawnable ()
	FMovieSceneSpawnable (const FString &InitName, UObject &InObjectTemplate)
UObject *	GetObjectTemplate ()
const UObject *	GetObjectTemplate () const
void	SetObjectTemplate (UObject *InObjectTemplate)
MOVIESCENE_API void	CopyObjectTemplate (UObject &InSourceObject, UMovieSceneSequence &MovieSceneSequence)
const FGuid &	GetGuid () const
void	SetGuid (const FGuid &InGuid)
const FString &	GetName () const
void	SetName (const FString &InName)
void	AddChildPossessable (const FGuid &PossessableGuid)
void	RemoveChildPossessable (const FGuid &PossessableGuid)
const TArray< FGuid > &	GetChildPossessables () const
ESpawnOwnership	GetSpawnOwnership () const
void	SetSpawnOwnership (ESpawnOwnership InOwnership)
FName	GetLevelName () const
void	SetLevelName (FName InLevelName)
MOVIESCENE_API FName	GetNetAddressableName (TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState, FMovieSceneSequenceID SequenceID) const
MOVIESCENE_API FName	GetNetAddressableName (IMovieScenePlayer &Player, FMovieSceneSequenceID SequenceID) const
MOVIESCENE_API void	AutoSetNetAddressableName ()
bool	operator< (const FMovieSceneSpawnable &RHS) const
bool	operator< (const FGuid &InGuid) const

Static Public Member Functions
static MOVIESCENE_API bool	IsSpawnableTemplate (const UObject &InObject)
static MOVIESCENE_API void	MarkSpawnableTemplate (const UObject &InObject)

Public Attributes
FTransform	SpawnTransform
TArray< FName >	Tags
bool	bContinuouslyRespawn
bool	bNetAddressableName
FMovieSceneDynamicBinding	DynamicBinding_DEPRECATED

Friends
bool	operator< (const FGuid &InGuid, const FMovieSceneSpawnable &RHS)

Detailed Description

MovieSceneSpawnable describes an object that can be spawned for this MovieScene

Constructor & Destructor Documentation

FMovieSceneSpawnable() [1/2]

FMovieSceneSpawnable::FMovieSceneSpawnable ( )

inline

FMovieSceneSpawnable() [2/2]

FMovieSceneSpawnable::FMovieSceneSpawnable ( const FString &  InitName, UObject &  InObjectTemplate  )

inline

FMovieSceneSpawnable initialization constructor

Member Function Documentation

AddChildPossessable()

void FMovieSceneSpawnable::AddChildPossessable ( const FGuid &  PossessableGuid )

inline

Report the specified GUID as being an inner possessable dependency for this spawnable

Parameters

PossessableGuid

The guid pertaining to the inner possessable

AutoSetNetAddressableName()

void FMovieSceneSpawnable::AutoSetNetAddressableName

(

)

Automatically determine a value for bNetAddressableName based on the spawnable type

CopyObjectTemplate()

void FMovieSceneSpawnable::CopyObjectTemplate	(	UObject &	InSourceObject,
		UMovieSceneSequence &	MovieSceneSequence
	)

Copy the specified object into this spawnable's template

Parameters

InSourceObject	The source object to use. This object will be duplicated into the spawnable.
MovieSceneSequence	The movie scene sequence to which this spawnable belongs

GetChildPossessables()

const TArray< FGuid > & FMovieSceneSpawnable::GetChildPossessables ( ) const

inline

Returns

const access to the child possessables set

GetGuid()

const FGuid & FMovieSceneSpawnable::GetGuid ( ) const

inline

Get the unique identifier of the spawnable object.

Returns

Object GUID.

See also

GetClass, GetName

GetLevelName()

FName FMovieSceneSpawnable::GetLevelName ( ) const

inline

Get the name of the level to spawn into.

Returns

Level name.

GetName()

const FString & FMovieSceneSpawnable::GetName ( ) const

inline

Get the name of the spawnable object.

Returns

Object name.

See also

GetClass, GetGuid

GetNetAddressableName() [1/2]

FName FMovieSceneSpawnable::GetNetAddressableName	(	IMovieScenePlayer &	Player,
		FMovieSceneSequenceID	SequenceID
	)		const

GetNetAddressableName() [2/2]

FName FMovieSceneSpawnable::GetNetAddressableName	(	TSharedRef< const UE::MovieScene::FSharedPlaybackState >	SharedPlaybackState,
		FMovieSceneSequenceID	SequenceID
	)		const

Get the name to use for spawning this object into a networked level

GetObjectTemplate() [1/2]

UObject * FMovieSceneSpawnable::GetObjectTemplate ( )

inline

Get the template object for this spawnable

Returns

Object template

See also

GetGuid, GetName

GetObjectTemplate() [2/2]

const UObject * FMovieSceneSpawnable::GetObjectTemplate ( ) const

inline

Get the template object for this spawnable

Returns

Object template

See also

GetGuid, GetName

GetSpawnOwnership()

ESpawnOwnership FMovieSceneSpawnable::GetSpawnOwnership ( ) const

inline

Get a value indicating what is responsible for this object once it's spawned

IsSpawnableTemplate()

bool FMovieSceneSpawnable::IsSpawnableTemplate ( const UObject &  InObject )

static

Check if the specified object is a spawnable template

Parameters

InObject

The object to test

Returns

true if the specified object is a spawnable template, false otherwise

MarkSpawnableTemplate()

void FMovieSceneSpawnable::MarkSpawnableTemplate ( const UObject &  InObject )

static

Indicate that the specified object is a spawnable template object

Parameters

InObject

The object to mark

operator<() [1/2]

bool FMovieSceneSpawnable::operator< ( const FGuid &  InGuid ) const

inline

operator<() [2/2]

bool FMovieSceneSpawnable::operator< ( const FMovieSceneSpawnable &  RHS ) const

inline

RemoveChildPossessable()

void FMovieSceneSpawnable::RemoveChildPossessable ( const FGuid &  PossessableGuid )

inline

Remove the specified GUID from this spawnables list of dependent possessables

Parameters

PossessableGuid

The guid pertaining to the inner possessable

SetGuid()

void FMovieSceneSpawnable::SetGuid ( const FGuid &  InGuid )

inline

Set the unique identifier of this spawnable object

Parameters

InGuid

The new GUID for this spawnable

Note

Be careful - this guid may be referenced by spawnable/possessable child-parent relationships.

See also

GetGuid

SetLevelName()

void FMovieSceneSpawnable::SetLevelName ( FName  InLevelName )

inline

Set the name of the level to spawn into.

@InLevelName The desired spawnable level name.

SetName()

void FMovieSceneSpawnable::SetName ( const FString &  InName )

inline

Set the name of the spawnable object.

@InName The desired spawnable name.

SetObjectTemplate()

void FMovieSceneSpawnable::SetObjectTemplate ( UObject *  InObjectTemplate )

inline

Set the object template to the specified object directly. Used for Copy/Paste, typically you should use CopyObjectTemplate.

SetSpawnOwnership()

void FMovieSceneSpawnable::SetSpawnOwnership ( ESpawnOwnership  InOwnership )

inline

Set a value indicating what is responsible for this object once it's spawned

Friends And Related Symbol Documentation

operator<

bool operator< ( const FGuid &  InGuid, const FMovieSceneSpawnable &  RHS  )

friend

Member Data Documentation

bContinuouslyRespawn

bool FMovieSceneSpawnable::bContinuouslyRespawn

When enabled, this spawnable will always be respawned if it gets destroyed externally. When disabled, this object will only ever be spawned once for each spawn key even if it is destroyed externally.

bNetAddressableName

bool FMovieSceneSpawnable::bNetAddressableName

When enabled, the actor will be spawned with a unique name so that it can be addressable between clients and servers.

DynamicBinding_DEPRECATED

FMovieSceneDynamicBinding FMovieSceneSpawnable::DynamicBinding_DEPRECATED

SpawnTransform

FTransform FMovieSceneSpawnable::SpawnTransform

Optional spawn transform

Tags

TArray<FName> FMovieSceneSpawnable::Tags

Array of tags that can be used for grouping and categorizing.

---

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

• Engine/Source/Runtime/MovieScene/Public/MovieSceneSpawnable.h
• Engine/Source/Runtime/MovieScene/Private/MovieSceneSpawnable.cpp