WorldPartitionBlueprintLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Kismet/BlueprintFunctionLibrary.h"
#include "WorldPartition/ActorDescContainer.h"
#include "WorldPartition/WorldPartitionActorDesc.h"
#include "WorldPartition/LoaderAdapter/LoaderAdapterActorList.h"
#include "WorldPartitionBlueprintLibrary.generated.h"
 
class FWorldPartitionActorDesc;
class FWorldPartitionActorDescInstance;
class UWorldPartition;
class UDataLayerManager;
 
USTRUCT(BlueprintType)
struct FActorDesc
{
    GENERATED_USTRUCT_BODY()
 
    FActorDesc();
 
#if WITH_EDITOR
    FActorDesc(const FWorldPartitionActorDescInstance& InActorDesc);
#endif
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FGuid Guid;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    TObjectPtr<UClass> NativeClass;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FSoftObjectPath Class;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FName Name;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FName Label;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FBox Bounds;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FName RuntimeGrid;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    bool bIsSpatiallyLoaded;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    bool bActorIsEditorOnly;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FName ActorPackage;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    FName ActorPath;
 
    UPROPERTY(BlueprintReadOnly, VisibleAnywhere, Category=Actor)
    TArray<FSoftObjectPath> DataLayerAssets;
};
 
UCLASS(MinimalAPI)
class UWorldPartitionBlueprintLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
#if WITH_EDITOR
    static UWorld* GetEditorWorld();
    static UWorldPartition* GetWorldPartition();
 
    static void OnWorldPartitionUninitialized(UWorldPartition* InWorldPartition);
    static TMap<UWorldPartition*, TUniquePtr<FLoaderAdapterActorList>> LoaderAdapterActorListMap;
    static FDelegateHandle OnWorldPartitionUninitializedHandle;
 
    static bool GetActorDescs(const UWorldPartition* WorldPartition, TArray<FActorDesc>& OutActorDescs);
    static bool GetActorDescs(const UActorDescContainerInstance* InContainer, TArray<FActorDesc>& OutActorDescs);
    static bool GetIntersectingActorDescs(UWorldPartition* WorldPartition, const FBox& InBox, TArray<FActorDesc>& OutActorDescs);
    static bool GetIntersectingActorDescs(const UActorDescContainerInstance* InContainerInstance, const FBox& InBox, TArray<FActorDesc>& OutActorDescs);
    static bool HandleIntersectingActorDesc(const FWorldPartitionActorDescInstance* ActorDescInstance, const FBox& InBox, TArray<FActorDesc>& OutActorDescs);
#endif
 
public:
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static FBox GetEditorWorldBounds();
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static FBox GetRuntimeWorldBounds();
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static void LoadActors(const TArray<FGuid>& InActorsToLoad);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static void UnloadActors(const TArray<FGuid>& InActorsToUnload);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static void PinActors(const TArray<FGuid>& InActorsToPin);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static void UnpinActors(const TArray<FGuid>& InActorsToUnpin);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static bool GetActorDescs(TArray<FActorDesc>& OutActorDescs);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static bool GetIntersectingActorDescs(const FBox& InBox, TArray<FActorDesc>& OutActorDescs);
 
    UFUNCTION(BlueprintCallable, Category="World Partition", meta=(DevelopmentOnly))
    static bool GetActorDescsForActors(const TArray<AActor*>& InActors, TArray<FActorDesc>& OutActorDescs);
 
    UFUNCTION(BlueprintCallable, Category = "World Partition", meta = (WorldContext = "WorldContextObject"))
    static UDataLayerManager* GetDataLayerManager(class UObject* WorldContextObject);
};