Navigation
API > API/Runtime > API/Runtime/MovieScene
A custom binding. Allows users to define their own binding resolution types, including dynamic 'Replaceable' bindings with previews in editor, as well as Spawnable types.
| Name | UMovieSceneCustomBinding |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneCustomBinding.h |
| Include Path | #include "Bindings/MovieSceneCustomBinding.h" |
Syntax
UCLASS (Abstract, DefaultToInstanced, EditInlineNew, MinimalAPI)
class UMovieSceneCustomBinding : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCustomBinding
Derived Classes
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BaseCustomPriority | const int32 | Bindings/MovieSceneCustomBinding.h | |
| BaseEnginePriority | const int32 | Bindings/MovieSceneCustomBinding.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieSceneSpawnableBindingBase * AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. | Bindings/MovieSceneCustomBinding.h | |
virtual const UMovieSceneSpawnableBindingBase * AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. | Bindings/MovieSceneCustomBinding.h | |
virtual bool CanConvertToPossessable
(
const FGuid& Guid, |
Called by UI code to see if this custom binding supports converting to a possessable. | Bindings/MovieSceneCustomBinding.h | |
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/MovieSceneCustomBinding.h | |
virtual UMovieSceneCustomBinding * CreateNewCustomBinding
(
UObject* SourceObject, |
Must be implemented. | Bindings/MovieSceneCustomBinding.h | |
virtual FSlateIcon GetBindingTrackCustomIconOverlay() |
Allows the custom binding to optionally provide a custom icon overlay for the object binding track. | Bindings/MovieSceneCustomBinding.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/MovieSceneCustomBinding.h | |
virtual FText GetBindingTypePrettyName() |
Must be implemented. Used by the UI to describe this binding type during conversions, etc. | Bindings/MovieSceneCustomBinding.h | |
virtual UClass * GetBoundObjectClass () |
Must be implemented. | Bindings/MovieSceneCustomBinding.h | |
virtual int32 GetCustomBindingPriority() |
Bindings/MovieSceneCustomBinding.h | ||
virtual FString GetDesiredBindingName () |
Optional method that can be overridden to return a desired name for the binding. | Bindings/MovieSceneCustomBinding.h | |
virtual void OnBindingAddedOrChanged
(
UMovieScene& OwnerMovieScene |
Called by UI code when the binding has recently been added or modified in the case anything needs to be initialized or modified based on this. | Bindings/MovieSceneCustomBinding.h | |
virtual FMovieSceneBindingResolveResult ResolveBinding
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. | Bindings/MovieSceneCustomBinding.h | |
virtual void SetupDefaults
(
UObject* SpawnedObject, |
Called by Sequencer upon creating a new custom binding or converting a binding to use this type. | Bindings/MovieSceneCustomBinding.h | |
virtual bool SupportsBindingCreationFromObject
(
const UObject* SourceObject |
Must be implemented. | Bindings/MovieSceneCustomBinding.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/MovieSceneCustomBinding.h | |
virtual bool WillSpawnObject
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
Returns whether this binding type will spawn an object in the current context. | Bindings/MovieSceneCustomBinding.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 GetBaseCustomPriority() |
Bindings/MovieSceneCustomBinding.h |
|
|
static int32 GetBaseEnginePriority() |
Bindings/MovieSceneCustomBinding.h |
|