MovieSceneDynamicBinding.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "EntitySystem/MovieSceneSequenceInstanceHandle.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "MovieSceneSequenceID.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
 
#include "MovieSceneDynamicBinding.generated.h"
 
class UMovieScene;
class UMovieSceneSequence;
class UMovieSceneEntitySystemLinker;
 
USTRUCT(BlueprintType)
struct FMovieSceneDynamicBindingPayloadVariable
{
    GENERATED_BODY()
        
    UPROPERTY()
    FSoftObjectPath ObjectValue;
 
    UPROPERTY(EditAnywhere, Category = "Sequencer|Dynamic Binding")
    FString Value;
};
 
USTRUCT()
struct FMovieSceneDynamicBinding
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    TObjectPtr<UFunction> Function;
 
    UPROPERTY()
    TFieldPath<FProperty> ResolveParamsProperty;
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Category = "Sequencer|Dynamic Binding")
    TMap<FName, FMovieSceneDynamicBindingPayloadVariable> PayloadVariables;
 
    UPROPERTY(transient)
    FName CompiledFunctionName;
 
    UPROPERTY(EditAnywhere, Category="Sequencer|Dynamic Binding")
    FName ResolveParamsPinName;
 
    UPROPERTY(EditAnywhere, Category="Sequencer|Dynamic Binding")
    TWeakObjectPtr<UObject> WeakEndpoint;
 
#endif
};
 
USTRUCT(BlueprintType)
struct FMovieSceneDynamicBindingResolveParams
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    TObjectPtr<UMovieSceneSequence> Sequence;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    FGuid ObjectBindingID;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    TObjectPtr<UMovieSceneSequence> RootSequence;
};
 
USTRUCT(BlueprintType)
struct FMovieSceneDynamicBindingResolveResult
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "General")
    TArray<TObjectPtr<UObject>> Objects;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "General", meta = (DeprecatedProperty, DeprecationMessage = "This property is deprecated, please use the array of Objects instead."))
    TObjectPtr<UObject> Object = nullptr;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="General")
    bool bIsPossessedObject = true;
};
 
USTRUCT()
struct FMovieSceneDynamicBindingContainer
{
    GENERATED_BODY()
 
    UPROPERTY(EditAnywhere, Category="Sequencer")
    FMovieSceneDynamicBinding DynamicBinding;
};
 
UCLASS(meta=(SequencerBindingResolverLibrary), MinimalAPI)
class UBuiltInDynamicBindingResolverLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintPure, Category="Sequencer|Dynamic Binding", meta=(WorldContext="WorldContextObject"))
    static MOVIESCENE_API FMovieSceneDynamicBindingResolveResult ResolveToPlayerPawn(UObject* WorldContextObject, int32 PlayerControllerIndex = 0);
};