Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Bindings
Inheritance Hierarchy
- UObject
- UMovieSceneCustomBinding
- UMovieSceneSpawnableBindingBase
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneSpawnableBinding.h |
| Include | #include "Bindings/MovieSceneSpawnableBinding.h" |
Syntax
UCLASS (Abstract)
class UMovieSceneSpawnableBindingBase : public UMovieSceneCustomBinding
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
bool | bContinuouslyRespawn | When enabled, this spawnable will always be respawned if it gets destroyed externally. |
    |
ESpawnOwnership | SpawnOwnership | The spawn ownership setting for this spawnable, allowing spawnables to potentially outlast the lifetime of their sub sequence or sequence altogether. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | CopyObjectTemplate
(
UObject* InSourceObject, |
Copy the specified object into this spawnable's template |
  |
void | DestroySpawnedObject
(
UObject* Object |
Called by the Movie Scene Spawner to destroy this previously spawned object |
  |
void | DestroySpawnedObjectInternal
(
UObject* Object |
Must be overridden. |
  |
UObject * | Override and return the object template if the binding type supports object templates | |
   |
FName | GetSpawnName
(
const FGuid& BindingId, |
Should returns the name of the object to be spawned if a custom name desired. |
   |
UWorld * | GetWorldContext
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
By default, objects will be spawned in Sequencer's current world context. |
  |
void | PostSpawnObject
(
UObject* SpawnedObject, |
Can be used by derived classes to perform custom post spawn setup on an object. |
  |
void | PreDestroyObject
(
UObject* Object, |
Called by the Movie Scene Spawner right before a spawned object with the specified ID and template ID is destroyed |
  |
void | SetObjectTemplate
(
UObject* InObjectTemplate |
Sets the object template to the specified object directly. |
  |
UObject * | SpawnObject
(
const FGuid& BindingId, |
Called by the Movie Scene Spawner for this spawnable binding to spawn its object. |
  |
UObject * | SpawnObjectInternal
(
UWorld* WorldContext, |
Must be overridden. |
   |
bool | Override and return true if the binding type supports object templates |
Overridden from UMovieSceneCustomBinding
| Type | Name | Description | |
|---|---|---|---|
   |
FSlateIcon | Allows the custom binding to optionally provide a custom icon overlay for the object binding track. | |
   |
FText | Allows the custom binding to optionally provide a custom tooltip to show when hovering over the icon area in the object binding track. | |
  |
void | SetupDefaults
(
UObject* SpawnedObject, |
UMovieSceneCustomBinding overrides |