Navigation
API > API/Runtime > API/Runtime/MovieScene
MovieSceneSpawnable describes an object that can be spawned for this MovieScene
| Name | FMovieSceneSpawnable |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/MovieSceneSpawnable.h |
| Include Path | #include "MovieSceneSpawnable.h" |
Syntax
USTRUCT ()
struct FMovieSceneSpawnable
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneSpawnable
(
const FString& InitName, |
FMovieSceneSpawnable initialization constructor | MovieSceneSpawnable.h | |
| MovieSceneSpawnable.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bContinuouslyRespawn | bool | When enabled, this spawnable will always be respawned if it gets destroyed externally. | MovieSceneSpawnable.h |
|
| bNetAddressableName | bool | When enabled, the actor will be spawned with a unique name so that it can be addressable between clients and servers. | MovieSceneSpawnable.h |
|
| LevelName | FName | Name of level to spawn into | MovieSceneSpawnable.h | |
| SpawnTransform | FTransform | Optional spawn transform | MovieSceneSpawnable.h |
|
| Tags | TArray< FName > | Array of tags that can be used for grouping and categorizing. | MovieSceneSpawnable.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChildPossessables | TArray< FGuid > | Set of GUIDs to possessable object bindings that are bound to an object inside this spawnable | MovieSceneSpawnable.h | |
| Guid | FGuid | Unique identifier of the spawnable object. | MovieSceneSpawnable.h | |
| Name | FString | Name label | MovieSceneSpawnable.h | |
| ObjectTemplate | TObjectPtr< UObject > | MovieSceneSpawnable.h | ||
| Ownership | ESpawnOwnership | Property indicating where ownership responsibility for this object lies | MovieSceneSpawnable.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddChildPossessable
(
const FGuid& PossessableGuid |
Report the specified GUID as being an inner possessable dependency for this spawnable | MovieSceneSpawnable.h | |
void AutoSetNetAddressableName() |
Automatically determine a value for bNetAddressableName based on the spawnable type | MovieSceneSpawnable.h | |
void CopyObjectTemplate
(
UObject& InSourceObject, |
Copy the specified object into this spawnable's template | MovieSceneSpawnable.h | |
| MovieSceneSpawnable.h | |||
| Get the unique identifier of the spawnable object. | MovieSceneSpawnable.h | ||
FName GetLevelName() |
Get the name of the level to spawn into. | MovieSceneSpawnable.h | |
const FString & GetName () |
Get the name of the spawnable object. | MovieSceneSpawnable.h | |
FName GetNetAddressableName
(
IMovieScenePlayer& Player, |
MovieSceneSpawnable.h | ||
FName GetNetAddressableName
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState, |
Get the name to use for spawning this object into a networked level | MovieSceneSpawnable.h | |
const UObject * GetObjectTemplate () |
Get the template object for this spawnable | MovieSceneSpawnable.h | |
UObject * GetObjectTemplate () |
Get the template object for this spawnable | MovieSceneSpawnable.h | |
ESpawnOwnership GetSpawnOwnership() |
Get a value indicating what is responsible for this object once it's spawned | MovieSceneSpawnable.h | |
void RemoveChildPossessable
(
const FGuid& PossessableGuid |
Remove the specified GUID from this spawnables list of dependent possessables | MovieSceneSpawnable.h | |
| Set the unique identifier of this spawnable object | MovieSceneSpawnable.h | ||
void SetLevelName
(
FName InLevelName |
Set the name of the level to spawn into.@InLevelName The desired spawnable level name. | MovieSceneSpawnable.h | |
void SetName
(
const FString& InName |
Set the name of the spawnable object.@InName The desired spawnable name. | MovieSceneSpawnable.h | |
void SetObjectTemplate
(
UObject* InObjectTemplate |
Set the object template to the specified object directly. | MovieSceneSpawnable.h | |
void SetSpawnOwnership
(
ESpawnOwnership InOwnership |
Set a value indicating what is responsible for this object once it's spawned | MovieSceneSpawnable.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsSpawnableTemplate
(
const UObject& InObject |
Check if the specified object is a spawnable template | MovieSceneSpawnable.h | |
static void MarkSpawnableTemplate
(
const UObject& InObject |
Indicate that the specified object is a spawnable template object | MovieSceneSpawnable.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DynamicBinding_DEPRECATED | FMovieSceneDynamicBinding | Property has been deprecated- 'Dynamic Bindings' are now handled by UMovieSceneReplaceableDirectorBlueprintBinding and the custom binding system. | MovieSceneSpawnable.h | |
| GeneratedClass_DEPRECATED | TObjectPtr< UClass > | Deprecated generated class | MovieSceneSpawnable.h |