1. Epic GamesDeveloper
  3. UMovieSceneSpawnableActorBindingBase

UMovieSceneSpawnableActorBindingBase

The base class for actor-specific spawnable bindings.

API > API/Runtime > API/Runtime/MovieSceneTracks > API/Runtime/MovieSceneTracks/Bindings

Inheritance Hierarchy

References

   
Module MovieSceneTracks
Header /Engine/Source/Runtime/MovieSceneTracks/Public/Bindings/MovieSceneSpawnableActorBinding.h
Include #include "Bindings/MovieSceneSpawnableActorBinding.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UMovieSceneSpawnableActorBindingBase : public UMovieSceneSpawnableBindingBase

Remarks

The base class for actor-specific spawnable bindings. Contains a default implementation that can handle spawning an Actor from provided Actor class and optional Actor template. Can be overridden in C++ or blueprint to provide an Actor class and to add custom PostSpawnObject behavior such as mesh setup based on an asset. The below UMovieSceneSpawnableActorBinding class implements this base class and replicates the old FMovieSceneSpawnable behavior by using a specified Actor template to spawn an Actor and can be used out of the box.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bNetAddressableName When enabled, the actor will be spawned with a unique name so that it can be addressable between clients and servers.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName LevelName Name of level to spawn into

Functions

  Type Name Description
Public function void Automatically determine a value for bNetAddressableName based on the spawnable type
Public function Virtual void

CopyObjectTemplate ( UObject* InSourceObject,
UMovieSceneSequence& MovieSceneSequence
)

 Copy the specified object into this spawnable's template
Protected function Virtual void

DestroySpawnedObjectInternal ( UObject* Object
)

 Overridden to handle Actor-specific destruction
Protected function Virtual Const TSubclassOf< AActor > TODO: Make UFUNCTION.
Protected function Virtual Const AActor * Optionally override to provide an Actor template to use during Spawn
Protected function Const UClass *  
Protected function Virtual Const int32 MovieSceneCustomBinding overrides
Public function Const FName Returns the optional level name to spawn the actor in, otherwise the Persistent level is used.
Public function Virtual UObject * Override and return the object template if the binding type supports object templates
Protected function Const FName

GetSpawnName ( const FGuid& BindingId,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

  
Protected function Const FTransform Returns the transform to spawn the actor at
Public function void

SetLevelName ( FName InLevelName
)

 Used to provide an optional level name to spawn the actor in, otherwise the Persistent level is used.
Public function Virtual void

SetObjectTemplate ( UObject* InObjectTemplate
)

 Sets the object template to the specified object directly.
Protected function Virtual UObject *

SpawnObjectInternal ( UWorld* WorldContext,
FName SpawnName,
const FGuid& BindingId,
int32 BindingIndex,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

 Overridden to handle Actor-specific spawning
Public function Virtual Const bool Override and return true if the binding type supports object templates.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page