WorldPartitionStreamingGenerationErrorHandler.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#if WITH_EDITOR
#include "CoreMinimal.h"
#include "WorldPartition/WorldPartitionActorDescInstanceViewInterface.h"
 
class AWorldDataLayers;
class UDataLayerAsset;
class UDataLayerInstance;
class UDataLayerInstanceWithAsset;
class UHLODLayer;
 
// deprecated
class FWorldPartitionActorDescView;
 
class IStreamingGenerationErrorHandler
{
public:
    virtual ~IStreamingGenerationErrorHandler() {}
 
    virtual void OnInvalidRuntimeGrid(const IWorldPartitionActorDescInstanceView& ActorDescView, FName GridName) = 0;
 
    virtual void OnInvalidReference(const IWorldPartitionActorDescInstanceView& ActorDescView, const FGuid& ReferenceGuid, IWorldPartitionActorDescInstanceView* ReferenceActorDescView) = 0;
 
    virtual void OnInvalidReferenceGridPlacement(const IWorldPartitionActorDescInstanceView& ActorDescView, const IWorldPartitionActorDescInstanceView& ReferenceActorDescView) = 0;
 
    enum class EDataLayerInvalidReason
    {
        ReferencedActorDifferentRuntimeDataLayers,
        ReferencedActorDifferentExternalDataLayer
    };
 
    virtual void OnInvalidReferenceDataLayers(const IWorldPartitionActorDescInstanceView& ActorDescView, const IWorldPartitionActorDescInstanceView& ReferenceActorDescView, EDataLayerInvalidReason Reason) = 0;
 
    virtual void OnInvalidReferenceRuntimeGrid(const IWorldPartitionActorDescInstanceView& ActorDescView, const IWorldPartitionActorDescInstanceView& ReferenceActorDescView) = 0;
 
    virtual void OnDataLayersLoadFilterMismatch(const IWorldPartitionActorDescInstanceView& ActorDescView) = 0;
 
    enum class EWorldReferenceInvalidReason
    {
        ReferencedActorIsSpatiallyLoaded,
        ReferencedActorHasDataLayers
    };
 
    virtual void OnInvalidWorldReference(const IWorldPartitionActorDescInstanceView& ActorDescView, EWorldReferenceInvalidReason Reason) = 0;
 
    virtual void OnInvalidReferenceDataLayerAsset(const UDataLayerInstanceWithAsset* DataLayerInstance) = 0;
 
    enum class EDataLayerHierarchyInvalidReason
    {
        ClientOnlyDataLayerCantBeChild,
        ServerOnlyDataLayerCantBeChild,
        IncompatibleDataLayerType
    };
 
    virtual void OnDataLayerHierarchyTypeMismatch(const UDataLayerInstance* DataLayerInstance, const UDataLayerInstance* Parent, EDataLayerHierarchyInvalidReason Reason) = 0;
 
    virtual void OnInvalidWorldDataLayersReference(const AWorldDataLayers* WorldDataLayers, const UDataLayerInstance* DataLayerInstance, const FText& Reason) = 0;
 
    virtual void OnDataLayerAssetConflict(const UDataLayerInstanceWithAsset* DataLayerInstance, const UDataLayerInstanceWithAsset* ConflictingDataLayerInstance) = 0;
 
    virtual void OnInvalidDataLayerAssetType(const UDataLayerInstanceWithAsset* DataLayerInstance, const UDataLayerAsset* DataLayerAsset) = 0;
 
    virtual void OnActorNeedsResave(const IWorldPartitionActorDescInstanceView& ActorDescView) = 0;
 
    enum class ELevelInstanceInvalidReason
    {
        WorldAssetNotFound,
        WorldAssetDontContainActorsMetadata,
        WorldAssetIncompatiblePartitioned,
        WorldAssetHasInvalidContainer,
        CirculalReference
    };
 
    virtual void OnLevelInstanceInvalidWorldAsset(const IWorldPartitionActorDescInstanceView& ActorDescView, FName WorldAsset, ELevelInstanceInvalidReason Reason) = 0;
 
    virtual void OnInvalidActorFilterReference(const IWorldPartitionActorDescInstanceView& ActorDescView, const IWorldPartitionActorDescInstanceView& ReferenceActorDescView) = 0;
 
    virtual void OnInvalidHLODLayer(const IWorldPartitionActorDescInstanceView& ActorDescView) = 0;
 
    enum class EHLODLayerUnsupportedReason
    {
        ActorClassUnsupportedByLayerType
    };
 
    virtual void OnUnsupportedHLODLayer(const IWorldPartitionActorDescInstanceView& ActorDescView, const UHLODLayer* HLODLayer, EHLODLayerUnsupportedReason Reason) = 0;
 
    // Helpers
    static ENGINE_API FString GetActorName(const IWorldPartitionActorDescInstanceView& ActorDescView);
    static ENGINE_API FString GetFullActorName(const IWorldPartitionActorDescInstanceView& ActorDescView);
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    
    UE_DEPRECATED(5.4, "Use OnInvalidReferenceDataLayers with EDataLayerInvalidReason instead.")
    virtual void OnInvalidReferenceDataLayers(const IWorldPartitionActorDescInstanceView& ActorDescView, const IWorldPartitionActorDescInstanceView& ReferenceActorDescView) final {}
 
    UE_DEPRECATED(5.2, "OnInvalidReference is deprecated, use the version which takes an optional actor descriptor view.")
    virtual void OnInvalidReference(const FWorldPartitionActorDescView& ActorDescView, const FGuid& ReferenceGuid) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidRuntimeGrid(const FWorldPartitionActorDescView& ActorDescView, FName GridName) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReference(const FWorldPartitionActorDescView& ActorDescView, const FGuid& ReferenceGuid, FWorldPartitionActorDescView* ReferenceActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReferenceGridPlacement(const FWorldPartitionActorDescView& ActorDescView, const FWorldPartitionActorDescView& ReferenceActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReferenceDataLayers(const FWorldPartitionActorDescView& ActorDescView, const FWorldPartitionActorDescView& ReferenceActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReferenceRuntimeGrid(const FWorldPartitionActorDescView& ActorDescView, const FWorldPartitionActorDescView& ReferenceActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReferenceLevelScriptStreamed(const FWorldPartitionActorDescView& ActorDescView) {}
    
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidReferenceLevelScriptDataLayers(const FWorldPartitionActorDescView& ActorDescView) {}
    
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnActorNeedsResave(const FWorldPartitionActorDescView& ActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnLevelInstanceInvalidWorldAsset(const FWorldPartitionActorDescView& ActorDescView, FName WorldAsset, ELevelInstanceInvalidReason Reason) {}
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidActorFilterReference(const FWorldPartitionActorDescView& ActorDescView, const FWorldPartitionActorDescView& ReferenceActorDescView) {}
    
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    virtual void OnInvalidHLODLayer(const FWorldPartitionActorDescView& ActorDescView) {}
 
    UE_DEPRECATED(5.4, "Use OnInvalidWorldReference instead")
    void OnInvalidReferenceLevelScriptStreamed(const IWorldPartitionActorDescInstanceView& ActorDescView) { OnInvalidWorldReference(ActorDescView, EWorldReferenceInvalidReason::ReferencedActorIsSpatiallyLoaded); }
 
    UE_DEPRECATED(5.4, "Use OnInvalidWorldReference instead")
    void OnInvalidReferenceLevelScriptDataLayers(const IWorldPartitionActorDescInstanceView& ActorDescView) { OnInvalidWorldReference(ActorDescView, EWorldReferenceInvalidReason::ReferencedActorHasDataLayers); }
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    static FString GetActorName(const FWorldPartitionActorDescView& ActorDescView) { return FString(); }
 
    UE_DEPRECATED(5.4, "Use IWorldPartitionActorDescInstanceView version instead")
    static FString GetFullActorName(const FWorldPartitionActorDescView& ActorDescView) { return FString(); }
 
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
};
#endif