LevelStreamingDynamic.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/PackageName.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Engine/LevelStreaming.h"
#include "LevelStreamingDynamic.generated.h"
 
UCLASS(BlueprintType, MinimalAPI)
class ULevelStreamingDynamic : public ULevelStreaming
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(Category=LevelStreaming, EditAnywhere)
    uint32 bInitiallyLoaded:1;
 
    UPROPERTY(Category=LevelStreaming, EditAnywhere)
    uint32 bInitiallyVisible:1;
    
    struct FLoadLevelInstanceParams
    {
        FLoadLevelInstanceParams(UWorld* InWorld, const FString& InLongPackageName, FTransform InLevelTransform)
            : World(InWorld)
            , LongPackageName(FPackageName::ObjectPathToPackageName(InLongPackageName))
            , LevelTransform(InLevelTransform) 
        {}
 
        UWorld* World = nullptr;
 
        FString LongPackageName;
 
        FTransform LevelTransform;
 
        const FString* OptionalLevelNameOverride = nullptr;
 
        TSubclassOf<ULevelStreamingDynamic> OptionalLevelStreamingClass;
 
        bool bLoadAsTempPackage = false;
 
        bool bInitiallyVisible = true;
 
        bool bAllowReuseExitingLevelStreaming = false;
 
        UObject* EditorPathOwner = nullptr;
 
        TUniqueFunction<void(ULevelStreaming*)> LevelStreamingCreatedCallback;
    };
 
    UFUNCTION(BlueprintCallable, Category = LevelStreaming, meta=(DisplayName = "Load Level Instance (by Name)", WorldContext="WorldContextObject"))
    static ENGINE_API ULevelStreamingDynamic* LoadLevelInstance(UObject* WorldContextObject, FString LevelName, FVector Location, FRotator Rotation, bool& bOutSuccess, const FString& OptionalLevelNameOverride = TEXT(""), TSubclassOf<ULevelStreamingDynamic> OptionalLevelStreamingClass = {}, bool bLoadAsTempPackage = false);
 
    UFUNCTION(BlueprintCallable, Category = LevelStreaming, meta=(DisplayName = "Load Level Instance (by Object Reference)", WorldContext="WorldContextObject"))
    static ENGINE_API ULevelStreamingDynamic* LoadLevelInstanceBySoftObjectPtr(UObject* WorldContextObject, TSoftObjectPtr<UWorld> Level, FVector Location, FRotator Rotation, bool& bOutSuccess, const FString& OptionalLevelNameOverride = TEXT(""), TSubclassOf<ULevelStreamingDynamic> OptionalLevelStreamingClass = {}, bool bLoadAsTempPackage = false);
    
    static ENGINE_API ULevelStreamingDynamic* LoadLevelInstanceBySoftObjectPtr(UObject* WorldContextObject, TSoftObjectPtr<UWorld> Level, const FTransform LevelTransform, bool& bOutSuccess, const FString& OptionalLevelNameOverride = TEXT(""), TSubclassOf<ULevelStreamingDynamic> OptionalLevelStreamingClass = {}, bool bLoadAsTempPackage = false);
 
    static ENGINE_API ULevelStreamingDynamic* LoadLevelInstance(const FLoadLevelInstanceParams& Params, bool& bOutSuccess);
 
    static ENGINE_API FString GetLevelInstancePackageName(const FLoadLevelInstanceParams& Params);
 
    //~ Begin UObject Interface
    ENGINE_API virtual void PostLoad() override;
    //~ End UObject Interface
 
    //~ Begin ULevelStreaming Interface
    virtual bool ShouldBeLoaded() const override { return bShouldBeLoaded; }
    //~ End ULevelStreaming Interface
 
    ENGINE_API virtual void SetShouldBeLoaded(bool bShouldBeLoaded) override;
 
private:
 
    // Counter used by LoadLevelInstance to create unique level names
    static ENGINE_API int32 UniqueLevelInstanceId;
 
    static ENGINE_API ULevelStreamingDynamic* LoadLevelInstance_Internal(const FLoadLevelInstanceParams& Params, bool& bOutSuccess);
 
};