FMovieSceneSpawnable

MovieSceneSpawnable describes an object that can be spawned for this MovieScene

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/MovieSceneSpawnable.h

Include

#include "MovieSceneSpawnable.h"

Syntax

struct FMovieSceneSpawnable

Remarks

MovieSceneSpawnable describes an object that can be spawned for this MovieScene

Variables

Name Description

Public variable

bool

 

bContinuouslyRespawn

When enabled, this spawnable will always be respawned if it gets destroyed externally.

Public variable

FName

 

LevelName

Name of level to spawn into

Public variable

FTransform

 

SpawnTransform

Optional spawn transform

Public variable

TArray< FName >

 

Tags

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

Constructors

Name Description

Public function

FMovieSceneSpawnable()

Public function

FMovieSceneSpawnable

(
    const FString& InitName,
    UObject& InObjectTemplate
)

FMovieSceneSpawnable initialization constructor

Functions

Name Description

Public function

void

 

AddChildPossessable

(
    const FGuid& PossessableGuid
)

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

Public function

void

 

CopyObjectTemplate

(
    UObject& InSourceObject,
    UMovieSceneSequence& MovieSceneSeq...
)

Copy the specified object into this spawnable's template

Public function Const

const TArray...

 

GetChildPossessables()

Public function Const

const FGuid ...

 

GetGuid()

Get the unique identifier of the spawnable object.

Public function Const

FName

 

GetLevelName()

Get the name of the level to spawn into.

Public function Const

const FStrin...

 

GetName()

Get the name of the spawnable object.

Public function

UObject *...

 

GetObjectTemplate()

Get the template object for this spawnable

Public function Const

const UObjec...

 

GetObjectTemplate()

Get the template object for this spawnable

Public function Const

ESpawnOwners...

 

GetSpawnOwnership()

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

Public function Static

bool

 

IsSpawnableTemplate

(
    const UObject& InObject
)

Check if the specified object is a spawnable template

Public function Static

void

 

MarkSpawnableTemplate

(
    const UObject& InObject
)

Indicate that the specified object is a spawnable template object

Public function

void

 

RemoveChildPossessable

(
    const FGuid& PossessableGuid
)

Remove the specified GUID from this spawnables list of dependent possessables

Public function

void

 

SetGuid

(
    const FGuid& InGuid
)

Set the unique identifier of this spawnable object

Public function

void

 

SetLevelName

(
    FName InLevelName
)

Set the name of the level to spawn into.

The desired spawnable level name.

Public function

void

 

SetName

(
    const FString& InName
)

Set the name of the spawnable object.

The desired spawnable name.

Public function

void

 

SetObjectTemplate

(
    UObject* InObjectTemplate
)

Set the object template to the specified object directly.

Public function

void

 

SetSpawnOwnership

(
    ESpawnOwnership InOwnership
)

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

Deprecated Variables

Name Description

Public variable

UClass *

 

GeneratedClass_DEPRECATED

Deprecated generated class

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss