Navigation
API > API/Runtime > API/Runtime/MovieScene
The base class for custom spawnable bindings. A spawnable binding will spawn an object upon resolution or return a cached previously spawned object. UMovieSceneSpawnableActorBinding is the reimplementation of previous FMovieSceneSpawnable features and spawns an actor based on a saved template and actor class. Otherwise, projects are free to implement their own Spawnable bindings by overriding this class. In doing so, they could choose to just override GetSpawnObjectClass, PostSpawnObject, and PreDestroyObject for example to do custom post-spawn setup on a character mesh, or they could choose to fully override SpawnObject and DestroySpawnedObject and do their own custom logic for spawning completely.
| Name | UMovieSceneSpawnableBindingBase |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneSpawnableBinding.h |
| Include Path | #include "Bindings/MovieSceneSpawnableBinding.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UMovieSceneSpawnableBindingBase : public UMovieSceneCustomBinding
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCustomBinding → UMovieSceneSpawnableBindingBase
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bContinuouslyRespawn | bool | When enabled, this spawnable will always be respawned if it gets destroyed externally. | Bindings/MovieSceneSpawnableBinding.h |
|
| SpawnOwnership | ESpawnOwnership | The spawn ownership setting for this spawnable, allowing spawnables to potentially outlast the lifetime of their sub sequence or sequence altogether. | Bindings/MovieSceneSpawnableBinding.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CopyObjectTemplate
(
UObject* InSourceObject, |
Copy the specified object into this spawnable's template | Bindings/MovieSceneSpawnableBinding.h | |
virtual void DestroySpawnedObject
(
UObject* Object |
Called by the Movie Scene Spawner to destroy this previously spawned object | Bindings/MovieSceneSpawnableBinding.h | |
virtual UObject * GetObjectTemplate() |
Override and return the object template if the binding type supports object templates | Bindings/MovieSceneSpawnableBinding.h | |
| Called by the Movie Scene Spawner right before a spawned object with the specified ID and template ID is destroyed | Bindings/MovieSceneSpawnableBinding.h | ||
virtual void SetObjectTemplate
(
UObject* InObjectTemplate |
Sets the object template to the specified object directly. | Bindings/MovieSceneSpawnableBinding.h | |
virtual UObject * SpawnObject
(
const FGuid& BindingId, |
Called by the Movie Scene Spawner for this spawnable binding to spawn its object. | Bindings/MovieSceneSpawnableBinding.h | |
virtual bool SupportsObjectTemplates() |
Override and return true if the binding type supports object templates | Bindings/MovieSceneSpawnableBinding.h |
Overridden from UMovieSceneCustomBinding
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FSlateIcon GetBindingTrackCustomIconOverlay() |
Allows the custom binding to optionally provide a custom icon overlay for the object binding track. | Bindings/MovieSceneSpawnableBinding.h | |
virtual FText GetBindingTrackIconTooltip() |
Allows the custom binding to optionally provide a custom tooltip to show when hovering over the icon area in the object binding track. | Bindings/MovieSceneSpawnableBinding.h | |
virtual void SetupDefaults
(
UObject* SpawnedObject, |
UMovieSceneCustomBinding overrides | Bindings/MovieSceneSpawnableBinding.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DestroySpawnedObjectInternal
(
UObject* Object |
Must be overridden. | Bindings/MovieSceneSpawnableBinding.h | |
virtual FName GetSpawnName
(
const FGuid& BindingId, |
Should returns the name of the object to be spawned if a custom name desired. | Bindings/MovieSceneSpawnableBinding.h | |
virtual UWorld * GetWorldContext
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
By default, objects will be spawned in Sequencer's current world context. | Bindings/MovieSceneSpawnableBinding.h | |
virtual void PostSpawnObject
(
UObject* SpawnedObject, |
Can be used by derived classes to perform custom post spawn setup on an object. | Bindings/MovieSceneSpawnableBinding.h | |
virtual UObject * SpawnObjectInternal
(
UWorld* WorldContext, |
Must be overridden. | Bindings/MovieSceneSpawnableBinding.h |