Navigation
API > API/Runtime > API/Runtime/MovieSceneTracks
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.
| Name | UMovieSceneSpawnableActorBindingBase |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieSceneTracks/Public/Bindings/MovieSceneSpawnableActorBinding.h |
| Include Path | #include "Bindings/MovieSceneSpawnableActorBinding.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UMovieSceneSpawnableActorBindingBase : public UMovieSceneSpawnableBindingBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCustomBinding → UMovieSceneSpawnableBindingBase → UMovieSceneSpawnableActorBindingBase
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bNetAddressableName | bool | When enabled, the actor will be spawned with a unique name so that it can be addressable between clients and servers. | Bindings/MovieSceneSpawnableActorBinding.h |
|
| LevelName | FName | Name of level to spawn into | Bindings/MovieSceneSpawnableActorBinding.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AutoSetNetAddressableName() |
Automatically determine a value for bNetAddressableName based on the spawnable type | Bindings/MovieSceneSpawnableActorBinding.h | |
FName GetLevelName() |
Returns the optional level name to spawn the actor in, otherwise the Persistent level is used. | Bindings/MovieSceneSpawnableActorBinding.h | |
void SetLevelName
(
FName InLevelName |
Used to provide an optional level name to spawn the actor in, otherwise the Persistent level is used. | Bindings/MovieSceneSpawnableActorBinding.h |
Overridden from UMovieSceneSpawnableBindingBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CopyObjectTemplate
(
UObject* InSourceObject, |
Copy the specified object into this spawnable's template | Bindings/MovieSceneSpawnableActorBinding.h | |
virtual UObject * GetObjectTemplate() |
Override and return the object template if the binding type supports object templates | Bindings/MovieSceneSpawnableActorBinding.h | |
virtual void SetObjectTemplate
(
UObject* InObjectTemplate |
Sets the object template to the specified object directly. | Bindings/MovieSceneSpawnableActorBinding.h | |
virtual bool SupportsObjectTemplates() |
Override and return true if the binding type supports object templates. | Bindings/MovieSceneSpawnableActorBinding.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSubclassOf< AActor > GetActorClass () |
TODO: Make UFUNCTION. | Bindings/MovieSceneSpawnableActorBinding.h | |
virtual AActor * GetActorTemplate() |
Optionally override to provide an Actor template to use during Spawn | Bindings/MovieSceneSpawnableActorBinding.h | |
FName GetSpawnName
(
const FGuid& BindingId, |
Bindings/MovieSceneSpawnableActorBinding.h | ||
FTransform GetSpawnTransform() |
Returns the transform to spawn the actor at | Bindings/MovieSceneSpawnableActorBinding.h | |
virtual UObject * SpawnObjectInternal
(
UWorld* WorldContext, |
Overridden to handle Actor-specific spawning | Bindings/MovieSceneSpawnableActorBinding.h |
Overridden from UMovieSceneSpawnableBindingBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DestroySpawnedObjectInternal
(
UObject* Object |
Overridden to handle Actor-specific destruction | Bindings/MovieSceneSpawnableActorBinding.h |
Overridden from UMovieSceneCustomBinding
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UClass * GetBoundObjectClass() |
Bindings/MovieSceneSpawnableActorBinding.h | ||
virtual int32 GetCustomBindingPriority() |
MovieSceneCustomBinding overrides | Bindings/MovieSceneSpawnableActorBinding.h |