Navigation
API > API/Runtime > API/Runtime/MovieScene
The base class for custom replaceable bindings. A replaceable binding uses an internal custom spawnable at editor time to produce a preview object, while in editor will use some other mechanism to dynamically bind an object to the track. Different replaceable types can choose different combinations of how to create a spawnable for preview vs. how to dynamically bind an object at runtime. UMovieSceneReplaceableActorBinding as an example is the simplest type of replaceable binding and provides no method for binding at runtime and relies on the LevelSequenceActor's Binding Override mechanism to bind an actor at runtime.
| Name | UMovieSceneReplaceableBindingBase |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneReplaceableBinding.h |
| Include Path | #include "Bindings/MovieSceneReplaceableBinding.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UMovieSceneReplaceableBindingBase : public UMovieSceneCustomBinding
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCustomBinding → UMovieSceneReplaceableBindingBase
Derived Classes
- UMovieSceneReplaceableActorBinding
- UMovieSceneReplaceableActorBinding_BPBase
- UMovieSceneReplaceableDirectorBlueprintBinding
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PreviewSpawnable | TObjectPtr< UMovieSceneSpawnableBindingBase > | Optional Editor-only preview object. | Bindings/MovieSceneReplaceableBinding.h |
|
Functions
Public
Overridden from UMovieSceneCustomBinding
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMovieSceneCustomBinding * CreateCustomBindingFromBinding
(
const FMovieSceneBindingReference& BindingReference, |
Called during binding conversion to create a new binding of this type from a selected binding, if supported. | Bindings/MovieSceneReplaceableBinding.h | |
virtual UMovieSceneCustomBinding * CreateNewCustomBinding
(
UObject* SourceObject, |
Note that we choose to implement CreateCustomBinding here rather than in subclasses. | Bindings/MovieSceneReplaceableBinding.h | |
virtual FSlateIcon GetBindingTrackCustomIconOverlay() |
Allows the custom binding to optionally provide a custom icon overlay for the object binding track. | Bindings/MovieSceneReplaceableBinding.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/MovieSceneReplaceableBinding.h | |
virtual UClass * GetBoundObjectClass () |
Must be implemented. | Bindings/MovieSceneReplaceableBinding.h | |
virtual void SetupDefaults
(
UObject* SpawnedObject, |
Called by Sequencer upon creating a new custom binding or converting a binding to use this type. | Bindings/MovieSceneReplaceableBinding.h | |
virtual bool SupportsBindingCreationFromObject
(
const UObject* SourceObject |
UMovieSceneCustomBinding overrides | Bindings/MovieSceneReplaceableBinding.h | |
virtual bool SupportsConversionFromBinding
(
const FMovieSceneBindingReference& BindingReference, |
Called by UI code to see if this custom binding type supports conversions from the presented binding, including any current bound or spawned object as reference. | Bindings/MovieSceneReplaceableBinding.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMovieSceneSpawnableBindingBase * CreateInnerSpawnable
(
UObject* SourceObject, |
Called from CreateNewCustomBinding to create the inner spawnable used for sequencer preview. | Bindings/MovieSceneReplaceableBinding.h | |
virtual TSubclassOf< UMovieSceneSpawnableBindingBase > GetInnerSpawnableClass() |
Must be implemented and return a non abstract spawnable binding class inheriting from UMovieSceneSpawnableBindingBase to use for the preview for this replaceable binding. | Bindings/MovieSceneReplaceableBinding.h | |
virtual void InitReplaceableBinding
(
UObject* SourceObject, |
Must be implemented. | Bindings/MovieSceneReplaceableBinding.h | |
virtual FMovieSceneBindingResolveResult ResolveRuntimeBindingInternal
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. | Bindings/MovieSceneReplaceableBinding.h |
Overridden from UMovieSceneCustomBinding
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const UMovieSceneSpawnableBindingBase * AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. | Bindings/MovieSceneReplaceableBinding.h | |
virtual FMovieSceneBindingResolveResult ResolveBinding
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. | Bindings/MovieSceneReplaceableBinding.h | |
virtual bool WillSpawnObject
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
UMovieSceneCustomBinding overrides | Bindings/MovieSceneReplaceableBinding.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
UObject overrides | Bindings/MovieSceneReplaceableBinding.h |