ChildActorComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Components/SceneComponent.h"
 
#include "ChildActorComponent.generated.h"
 
class AActor;
 
USTRUCT()
struct FChildActorAttachedActorInfo
{
    GENERATED_BODY()
 
    UPROPERTY()
    TWeakObjectPtr<AActor> Actor;
    UPROPERTY()
    FName SocketName;
    UPROPERTY()
    FTransform RelativeTransform;
};
 
USTRUCT()
struct FChildActorComponentInstanceData : public FSceneComponentInstanceData
{
    GENERATED_BODY()
public:
    FChildActorComponentInstanceData() = default;
    ENGINE_API FChildActorComponentInstanceData(const class UChildActorComponent* Component);
 
    virtual ~FChildActorComponentInstanceData() = default;
 
    ENGINE_API virtual bool ContainsData() const override;
 
    ENGINE_API virtual void ApplyToComponent(UActorComponent* Component, const ECacheApplyPhase CacheApplyPhase) override;
    ENGINE_API virtual void AddReferencedObjects(FReferenceCollector& Collector) override;
 
    // The class of the child actor when the instance data cache was stored
    UPROPERTY()
    TSubclassOf<AActor> ChildActorClass;
 
    // The name of the spawned child actor so it (attempts to) remain constant across construction script reruns
    UPROPERTY()
    FName ChildActorName;
 
    UPROPERTY()
    TArray<FChildActorAttachedActorInfo> AttachedActors;
 
#if WITH_EDITOR
    FGuid ChildActorGUID;
#endif
 
    // The saved properties for the ChildActor itself
    TSharedPtr<FActorInstanceData> ActorInstanceData;
 
    // The component instance data cache for the ChildActor spawned by this component
    TSharedPtr<FComponentInstanceDataCache> ComponentInstanceData;
};
 
#if WITH_EDITORONLY_DATA
UENUM()
enum class EChildActorComponentTreeViewVisualizationMode : uint8
{
    UseDefault UMETA(Hidden),
    ComponentOnly,
    ComponentWithChildActor,
    ChildActorOnly,
    Hidden,
};
#endif
 
UCLASS(ClassGroup=Utility, hidecategories=(Object,LOD,Physics,Lighting,TextureStreaming,Activation,"Components|Activation",Collision), meta=(BlueprintSpawnableComponent), MinimalAPI)
class UChildActorComponent : public USceneComponent
{
    GENERATED_UCLASS_BODY()
 
    
    UFUNCTION(BlueprintCallable, Category=ChildActorComponent)
    void SetChildActorClass(TSubclassOf<AActor> InClass)
    {
        SetChildActorClass(InClass, nullptr);
    }
 
    ENGINE_API void SetChildActorClass(TSubclassOf<AActor> InClass, AActor* NewChildActorTemplate);
 
    TSubclassOf<AActor> GetChildActorClass() const { return ChildActorClass; }
 
    friend class FChildActorComponentDetails;
 
private:
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ChildActorComponent, meta=(OnlyPlaceable, AllowPrivateAccess="true", ForceRebuildProperty="ChildActorTemplate"))
    TSubclassOf<AActor> ChildActorClass;
 
    UPROPERTY(Replicated, BlueprintReadOnly, ReplicatedUsing=OnRep_ChildActor, Category=ChildActorComponent, TextExportTransient, DuplicateTransient, meta=(AllowPrivateAccess="true"))
    TObjectPtr<AActor>  ChildActor;
 
    UPROPERTY(VisibleDefaultsOnly, DuplicateTransient, Category=ChildActorComponent, meta=(ShowInnerProperties))
    TObjectPtr<AActor> ChildActorTemplate;
 
    FName ChildActorName;
 
    UObject* ActorOuter;
 
    mutable FChildActorComponentInstanceData* CachedInstanceData;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    EChildActorComponentTreeViewVisualizationMode EditorTreeViewVisualizationMode;
#endif
 
    UPROPERTY(EditDefaultsOnly, Category=ChildActorComponent)
    uint8 bChildActorIsTransient:1;
 
    UPROPERTY(EditDefaultsOnly, Category=ChildActorComponent)
    uint8 bSetOwner:1;
 
    uint8 bNeedsRecreate:1;
 
    uint8 bChildActorNameIsExact:1;
 
#if WITH_EDITOR
    ENGINE_API virtual void SetPackageExternal(bool bExternal, bool bShouldDirty) override;
#endif
 
public:
 
    ENGINE_API static bool ExperimentalAllowPerInstanceChildActorProperties();
 
    //~ Begin Object Interface.
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void PostEditImport() override;
    ENGINE_API virtual void PostEditUndo() override;
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual EDataValidationResult IsDataValid(class FDataValidationContext& Context) const override;
#endif
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual void BeginDestroy() override;
    ENGINE_API virtual void GetLifetimeReplicatedProps(TArray<FLifetimeProperty>& OutLifetimeProps) const override;
    ENGINE_API virtual void PostRepNotifies() override;
    static ENGINE_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
    //~ End Object Interface.
 
    //~ Begin ActorComponent Interface.
    ENGINE_API virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;
    ENGINE_API virtual void OnRegister() override;
    ENGINE_API virtual void OnUnregister() override;
    ENGINE_API virtual TStructOnScope<FActorComponentInstanceData> GetComponentInstanceData() const override;
    ENGINE_API virtual void BeginPlay() override;
    ENGINE_API virtual bool IsHLODRelevant() const override;
#if WITH_EDITOR
    ENGINE_API virtual TSubclassOf<class UHLODBuilder> GetCustomHLODBuilderClass() const override;
#endif
    //~ End ActorComponent Interface.
 
    ENGINE_API void ApplyComponentInstanceData(FChildActorComponentInstanceData* ComponentInstanceData, const ECacheApplyPhase CacheApplyPhase);
 
    ENGINE_API virtual void CreateChildActor(TFunction<void(AActor*)> CustomizerFunc = nullptr);
 
    DECLARE_EVENT_OneParam(UChildActorComponent, FOnChildActorCreated, AActor*);
    FOnChildActorCreated& OnChildActorCreated() { return OnChildActorCreatedDelegate; }
 
    AActor* GetChildActor() const { return ChildActor; }
    AActor* GetChildActorTemplate() const { return ChildActorTemplate; }
    ENGINE_API AActor* GetSpawnableChildActorTemplate() const;
 
    FName GetChildActorName() const { return ChildActorName; }
    ENGINE_API void SetChildActorName(const FName InName);
 
    ENGINE_API void SetChildActorNameIsExact(bool bInExact);
 
    ENGINE_API void DestroyChildActor();
 
#if WITH_EDITOR
    EChildActorComponentTreeViewVisualizationMode GetEditorTreeViewVisualizationMode() const
    {
        return EditorTreeViewVisualizationMode;
    }
 
    ENGINE_API void SetEditorTreeViewVisualizationMode(EChildActorComponentTreeViewVisualizationMode InMode);
#endif
 
    ENGINE_API virtual void RegisterReplicationFragments(UE::Net::FFragmentRegistrationContext& Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags) override;
 
 
private:
    ENGINE_API bool IsChildActorReplicated() const;
 
    ENGINE_API bool IsLevelBeingRemoved() const;
 
    UFUNCTION()
    void OnRep_ChildActor();
 
    void RegisterChildActorDestroyedDelegate();
 
    UFUNCTION()
    ENGINE_API void OnChildActorDestroyed(AActor* Actor);
 
    FOnChildActorCreated OnChildActorCreatedDelegate;
};
 
struct FActorParentComponentSetter
{
    static void Set(AActor* ChildActor, UChildActorComponent* ParentComponent);
private:
    friend UChildActorComponent;
};