Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Bindings
Inheritance Hierarchy
- UObject
- UMovieSceneCustomBinding
- UMovieSceneReplaceableBindingBase
- UMovieSceneSpawnableBindingBase
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/Bindings/MovieSceneCustomBinding.h |
| Include | #include "Bindings/MovieSceneCustomBinding.h" |
Syntax
UCLASS (Abstract, DefaultToInstanced, EditInlineNew)
class UMovieSceneCustomBinding : public UObject
Remarks
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.
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
UMovieSceneSpawnableBindingBase * | AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. |
   |
const UMovieSceneSpawnableBindingBase * | AsSpawnable
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
For custom bindings inheriting from UMovieSceneSpawnableBindingBase, returns this object cast to UMovieSceneSpawnableBindingBase. |
   |
bool | CanConvertToPossessable
(
const FGuid& Guid, |
Called by UI code to see if this custom binding supports converting to a possessable. |
  |
UMovieSceneCustomBinding * | CreateCustomBindingFromBinding
(
const FMovieSceneBindingReference& BindingReference, |
Called during binding conversion to create a new binding of this type from a selected binding, if supported. |
  |
UMovieSceneCustomBinding * | CreateNewCustomBinding
(
UObject* SourceObject, |
Must be implemented. |
    |
int32 | ||
    |
int32 | ||
   |
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. | |
   |
FText | Must be implemented. Used by the UI to describe this binding type during conversions, etc. | |
   |
UClass * | Must be implemented. | |
   |
int32 | ||
   |
FString | Optional method that can be overridden to return a desired name for the binding. | |
  |
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. |
   |
FMovieSceneBindingResolveResult | ResolveBinding
(
const FMovieSceneBindingResolveParams& ResolveParams, |
Must be implemented. |
  |
void | SetupDefaults
(
UObject* SpawnedObject, |
Called by Sequencer upon creating a new custom binding or converting a binding to use this type. |
   |
bool | SupportsBindingCreationFromObject
(
const UObject* SourceObject |
Must be implemented. |
   |
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. |
   |
bool | WillSpawnObject
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
Returns whether this binding type will spawn an object in the current context. |
Constants
| Name | Description |
|---|---|
| BaseCustomPriority | |
| BaseEnginePriority |