MovieSceneSpawnable.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Misc/Guid.h"
#include "MovieSceneDynamicBinding.h"
 
#include "MovieSceneSpawnable.generated.h"
 
class IMovieScenePlayer;
class UMovieSceneSequence;
struct FMovieSceneSequenceID;
 
namespace UE::MovieScene
{
    struct FSharedPlaybackState;
}
 
UENUM()
enum class ESpawnOwnership : uint8
{
    InnerSequence UMETA(DisplayName = "This Sequence"),
 
    RootSequence,
 
    External,
};
 
USTRUCT()
struct FMovieSceneSpawnable
{
    GENERATED_BODY()
 
    FMovieSceneSpawnable()
        : bContinuouslyRespawn(false)
        , bNetAddressableName(false)
        , ObjectTemplate(nullptr)
        , Ownership(ESpawnOwnership::InnerSequence)
#if WITH_EDITORONLY_DATA
        , GeneratedClass_DEPRECATED(nullptr)
#endif
    {
    }
 
    FMovieSceneSpawnable(const FString& InitName, UObject& InObjectTemplate)
        : bContinuouslyRespawn(false)
        , bNetAddressableName(false)
        , Guid(FGuid::NewGuid())
        , Name(InitName)
        , ObjectTemplate(&InObjectTemplate)
        , Ownership(ESpawnOwnership::InnerSequence)
#if WITH_EDITORONLY_DATA
        , GeneratedClass_DEPRECATED(nullptr)
#endif
    {
        MarkSpawnableTemplate(InObjectTemplate);
    }
 
public:
 
    MOVIESCENE_API static bool IsSpawnableTemplate(const UObject& InObject);
 
    MOVIESCENE_API static void MarkSpawnableTemplate(const UObject& InObject);
 
    UObject* GetObjectTemplate()
    {
        return ObjectTemplate;
    }
 
    const UObject* GetObjectTemplate() const
    {
        return ObjectTemplate;
    }
 
    void SetObjectTemplate(UObject* InObjectTemplate)
    {
        checkf(InObjectTemplate == nullptr || !InObjectTemplate->HasAnyFlags(RF_ClassDefaultObject), TEXT("Setting CDOs as object templates is not supported. Please use the class directly."));
        ObjectTemplate = InObjectTemplate;
    }
 
    MOVIESCENE_API void CopyObjectTemplate(UObject& InSourceObject, UMovieSceneSequence& MovieSceneSequence);
 
    const FGuid& GetGuid() const
    {
        return Guid;
    }
 
    void SetGuid(const FGuid& InGuid)
    {
        Guid = InGuid;
    }
 
    const FString& GetName() const
    {
        return Name;
    }
 
    void SetName(const FString& InName)
    {
        Name = InName;
    }
 
    void AddChildPossessable(const FGuid& PossessableGuid)
    {
        ChildPossessables.AddUnique(PossessableGuid);
    }
 
    void RemoveChildPossessable(const FGuid& PossessableGuid)
    {
        ChildPossessables.Remove(PossessableGuid);
    }
 
    const TArray<FGuid>& GetChildPossessables() const
    {
        return ChildPossessables;
    }
 
    ESpawnOwnership GetSpawnOwnership() const
    {
        return Ownership;
    }
 
    void SetSpawnOwnership(ESpawnOwnership InOwnership)
    {
        Ownership = InOwnership;
    }
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category = Actor)
    FTransform SpawnTransform;
 
    FName GetLevelName() const
    {
        return LevelName;
    }
 
    void SetLevelName(FName InLevelName)
    {
        LevelName = InLevelName;
    }
 
    MOVIESCENE_API FName GetNetAddressableName(TSharedRef<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, FMovieSceneSequenceID SequenceID) const;
 
    UE_DEPRECATED(5.4, "Please use the FSharedPlaybackState version of this method")
    MOVIESCENE_API FName GetNetAddressableName(IMovieScenePlayer& Player, FMovieSceneSequenceID SequenceID) const;
 
    MOVIESCENE_API void AutoSetNetAddressableName();
 
    /* For sorts and BinarySearch so we can search quickly by Guid */
    inline bool operator<(const FMovieSceneSpawnable& RHS) const { return Guid < RHS.Guid; }
    inline friend bool operator<(const FGuid& InGuid, const FMovieSceneSpawnable& RHS) { return InGuid < RHS.GetGuid(); }
    inline bool operator<(const FGuid& InGuid) const { return Guid < InGuid; }
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category=Actor)
    TArray<FName> Tags;
 
    UPROPERTY(EditAnywhere, Category=Actor)
    bool bContinuouslyRespawn;
 
    UPROPERTY(EditAnywhere, Category=Actor)
    bool bNetAddressableName;
 
    // Property has been deprecated- 'Dynamic Bindings' are now handled by UMovieSceneReplaceableDirectorBlueprintBinding and the custom binding system
    UPROPERTY()
    FMovieSceneDynamicBinding DynamicBinding_DEPRECATED;
 
private:
 
    // @todo sequencer: Guids need to be handled carefully when the asset is duplicated (or loaded after being copied on disk).
    //                  Sometimes we'll need to generate fresh Guids.
    UPROPERTY()
    FGuid Guid;
 
    // @todo sequencer: Should be editor-only probably
    UPROPERTY()
    FString Name;
 
    UPROPERTY()
    TObjectPtr<UObject> ObjectTemplate;
 
    // @todo sequencer: This should be a TSet, but they don't duplicate correctly atm
    UPROPERTY()
    TArray<FGuid> ChildPossessables;
 
    UPROPERTY()
    ESpawnOwnership Ownership;
 
#if WITH_EDITORONLY_DATA
public:
    UPROPERTY()
    TObjectPtr<UClass> GeneratedClass_DEPRECATED;
#endif
 
    UPROPERTY()
    FName LevelName;
};