ProceduralDungeonBuilder.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Data/DungeonData.h"
#include "GameFramework/Actor.h"
#include "ProceduralDungeonBuilder.generated.h"
 
struct FDungeonSpawnRoom;
struct FDungeonSpecialItem;
class IDungeonRoom;
 
DECLARE_LOG_CATEGORY_EXTERN(LogDungeonBuilder, Display, All);
 
 
// Create different Methods of generating
// Method 1
//  Spawns Room, then spawning joining rooms at random
//  Problem with overlaps currently
// Method 2
//  Create Grid that is the total size of the Ship
//  Split the grid up into different squares
//  Spawn Important Rooms and large rooms first
//  Then spawn connecting Hallways
//  
 
 
 
 
UCLASS()
class PROCEDURALDUNGEONS_API AProceduralDungeonBuilder : public AActor
{
    GENERATED_BODY()
 
public:
    AProceduralDungeonBuilder();
 
 
 
protected:
    virtual void BeginPlay() override;
    virtual void OnConstruction(const FTransform& Transform) override;
    UFUNCTION(CallInEditor, Category="Dungeon|Editor")
    void CreateDungeonInEditor();
    UFUNCTION(CallInEditor, Category="Dungeon|Editor")
    void DestroyDungeonInEditor();
 
    UFUNCTION(CallInEditor, Category="Dungeon|Editor")
    void HideAllRoomRoofs();
 
    UFUNCTION(BlueprintCallable, Category="Dungeon")
    void CreateDungeon();
 
    UFUNCTION(BlueprintImplementableEvent, Category="Dungeon")
    void OnDungeonComplete(const int32 NumOfRooms);
    UFUNCTION(BlueprintImplementableEvent, Category="Dungeon")
    void OnDoorsSpawned(const int32 NumOfDoors);
 
    UFUNCTION(BlueprintImplementableEvent, Category="Dungeon")
    void OnAISpawned(const int32 NumOfPawns);
    UFUNCTION(NetMulticast, Reliable)
    void Multicast_DungeonComplete(int32 NumRooms);
 
    // UFUNCTION(BlueprintCallable, Category="Dungeon")
    // void SetRandomStream(const FRandomStream& Stream){RandomStream = Stream;};
    UFUNCTION(BlueprintCallable, Category="Dungeon")
    FRandomStream& GetRandomStream() const;
 
    UFUNCTION(BlueprintCallable, Category="Dungeon|Helper")
    bool IsOverlapping(const FBox& CandidateBox);
 
    // UFUNCTION(BlueprintCallable, Category="Dungeon|Helper")
    // bool IsValidRoomConnection(const EDungeonRoomType ParentType, const EDungeonRoomType CandidateType) const;
    UFUNCTION(BlueprintNativeEvent, Category="Dungeon|Helper")
    bool GetIsValidRoomConnection(const EDungeonRoomType ParentType, const EDungeonRoomType CandidateType) const;
 
    
    UFUNCTION(BlueprintCallable, Category="Dungeon|Debug")
    UMaterialInstanceDynamic* GetMaterialInstance() const {return RoomMaterialInstance;};
 
 
    //~     Lifetime of the Builder     ~//
    void SpawnStartingRoom();
    
    void SpawnAllRooms();
 
    void CreateDynamicMaterials();
 
    void SpawnNextRoom();
    
    // void SpawnNextRoomMathematically();
 
    void ContinueSpawnNextRoom();
 
    void SetInitialValues();
 
    void SpawnSpecialRoom();
    // void SpawnSpecialRoomMathematically();
 
    void ScheduleSpawn(const FTimerDelegate::TMethodPtr<AProceduralDungeonBuilder> SpawnMethod);
 
    void AddAISpawnPointsToList(const USceneComponent* AIRootComponent);
    void CheckExitsForJoiningRooms();
    void CloseHoles();
    void SpawnDoorAtLocation();
    void SpawnAIAtLocation();
 
    void SetRoomsReady() const;
 
    void DungeonComplete();
    //~     Lifetime of the Builder     ~//
 
    //~     Main Variables to set       ~//
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms")
    FDungeonSpawns RoomTypes;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms")
    int32 StartingRoomNumber = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms|Amount")
    int32 NumberOfRoomsToSpawn = 50;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms|Amount")
    bool bUseRandomNumberOfRooms = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms|Amount", meta=(EditCondition="bUseRandomNumberOfRooms"))
    int32 MinNumberOfRoomsToSpawn = 2;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms")
    TSubclassOf<AActor> RoomChecker = nullptr;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms")
    bool bApplyDynamicMaterial = true;
    // Checks if the EDungeonRoomType is Compatable with the next Dungeon
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms", meta=(EditCondition="bApplyDynamicMaterial"))
    UMaterialInterface* RoomMaterial = nullptr;
    //@ TODO add on Base? or Base Helpers, Or somewhere..
    // @ Check shipbuilder BP 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Rooms", meta=(EditCondition="bApplyDynamicMaterial"))
    class UDataTable* MaterialDataTable = nullptr; 
 
    // if theres only 1 available exit left, don't spawn a Dead end.
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General|Exits")
    bool bCheckRoomExitCount = false;
    // Total Exits are at x Don't spawn dead ends, 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General|Exits")
    int32 CheckRoomExitCountMin = 3;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    bool bCheckRoomTypes = true;
 
    // Gets the exit closest to the Origin when finding new Exits to spawn from 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General|Exits")
    bool bGetClosestExit = false;
    // Only Get closest Exit Randomly 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General|Exits", meta=(EditCondition=bGetClosestExit))
    bool bRandomGetClosestExit = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General|Exits", meta=(EditCondition=bRandomGetClosestExit))
    float RandomClosesExitWeight = 0.5f;
 
    // UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    // bool bUseSpawnNextRoomMathematically = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    bool bUseRandomSeed = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General", meta=(EditCondition="!bUseRandomSeed"))
    int32 Seed = 0;
    //@ TODO Change to Array?   
    //@ TODO Create Style Enum or Type, get from interface, then can match the Wall to the Room Style 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Walls")
    TSubclassOf<AActor> WallFill = nullptr;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Walls")
    bool bFillWithDeadEndRooms = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Doors")
    bool bSpawnDoors = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Doors", meta=(EditCondition="bSpawnDoors"))
    bool bLimitDoors = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Doors", meta=(EditCondition="bLimitDoors"))
    int32 DoorLimit = 10;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Doors")
    TArray<TSubclassOf<AActor>> DoorTypes;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|Doors")
    TArray<int32> DoorWeights;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    bool bCreateOnBeginPlay = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    bool bUseGameModeStream = true;
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|General")
    bool bCheckForJoiningRooms = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|AI")
    int32 AIToSpawn = 10;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Dungeon|AI")
    TArray<TSubclassOf<AActor>> AITypes;
    //~             Main Variables to set           ~//
 
    
    
    //~         Variables about the Dungeon         ~//
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    bool bComplete = false;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<USceneComponent*> AvailableExits;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<USceneComponent*> DoorLocations;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<USceneComponent*> ExitsToFill;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    USceneComponent* SelectedExit = nullptr;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    AActor* LastSpawnedRoom = nullptr;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<UPrimitiveComponent*> OverlappedComponents;
    UPROPERTY(Replicated, VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<AActor*> DungeonActors;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<TSubclassOf<AActor>> SpecialRoomTypeClasses;
 
    //@TODO Move all Actors to Categories
    // UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    // TArray<AActor*> DungeonRooms;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Rooms")
    UMaterialInstanceDynamic* RoomMaterialInstance = nullptr;
    
    // Stores each successfully spawned room’s world bounding box.
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Rooms")
    TArray<FBox> PlacedRoomBounds;
    
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    USceneComponent* SelectedAISpawn = nullptr;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    USceneComponent* SelectedDoorSpawn = nullptr;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    TArray<USceneComponent*> AISpawns;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation")
    bool bUsingGameModeSteam = false;
    //~      Variables about the Dungeon        ~//
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Debug")
    TArray<USceneComponent*> AISpawnsSelected;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Debug")
    TArray<USceneComponent*> AISpawnsFailed;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Debug")
    TArray<USceneComponent*> DoorSpawnsSelected;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Dungeon|Creation|Debug")
    TArray<USceneComponent*> DoorSpawnsFailed;
 
 
private:
    void OnRoomsComplete();
    
    void CheckRoomAttemptsNumber();
    void SetSeed();
    void SetNumberOfRooms();
 
    bool GetShouldStopSpawningRooms() const;
 
 
    bool GetShouldSpawnSpecialRoom() const;
 
    USceneComponent* GetNextExit();
    
    UClass* GetNewRoomClass() const;
    UClass* GetStartingRoomClass();
    UClass* GetSpecialRoomClass() const;
    UClass* GetDeadEndRoomClass() const;
 
    UFUNCTION(BlueprintCallable, Category="Dungeon", DisplayName="Get Rooms Of Type")
    TArray<FDungeonSpawnRoom> GetRoomsOfTypeBP(const TArray<EDungeonRoomType>& FilterTypes, const bool bInverseSelection = false) const;
    
    // Gets all rooms of the FilterTypes, Inverse will remove all these types
    TArray<FDungeonSpawnRoom> GetRoomsOfType(const TArray<EDungeonRoomType>& FilterTypes, const bool bInverseSelection = false) const;
    TArray<FDungeonSpawnRoom> GetRoomsOfType(const EDungeonRoomType FilterType, const bool bInverseSelection = false) const;
 
    // TArray<FDungeonSpawnRoom> GetRoomsExceptType(const TArray<EDungeonRoomType>& FilterTypes) const;
    TArray<FDungeonSpawnRoom> GetRoomsByExits() const;
    // TArray<FDungeonSpawnRoom> GetRooms(const bool bFilterExits, const bool bFilter = false, const EDungeonRoomType FilterType = EDungeonRoomType::SpecialRoom) const;
    
    void RemoveExitsByDistance(TArray<USceneComponent*>& ExitsA, TArray<USceneComponent*>& ExitsB) const;
 
    
    // Returns if Success
    bool SetDungeonValues();
    // bool AddDungeon
    // /** Gets random Room class from the array*/
    // FDungeonSpecialItem* GetRandomSpecialItem(TArray<FDungeonSpecialItem>& Array, FRandomStream& Stream) const;
    // USceneComponent* GetRandomSceneComponent(const TArray<USceneComponent*>& Array) const;
    // /** Gets random  from the array */
    // UClass* GetRandomClass(const TArray<TSubclassOf<AActor>>& Array) const;
 
    void LogDebugError(const FString& Message) const;
    void LogDebugWarning(const FString& Message) const;
    void LogDebugMessage(const FString& Message, const bool bWarning = false, const bool bError = false) const;
 
    
    
 
    FActorSpawnParameters SpawnParams;
    UPROPERTY(VisibleAnywhere, Category="Dungeon|Rooms")
    int32 RoomsSpawned = 0;
    int32 AttemptChecker = 0;
 
    UPROPERTY(VisibleAnywhere, Category="Dungeon|Rooms")
    int32 StartingNumberOfRoomsToSpawn = 0;
    UPROPERTY(VisibleAnywhere, Category="Dungeon|Rooms")
    int32 TotalNumberOfRoomsToSpawn = 0;
    FDungeonSpawns StartingRoomTypes;
    // TArray<TSubclassOf<AActor>> StartingRoomTypes;
    // TArray<FDungeonSpecialItem> StartingSpecialRoomTypes;
    UPROPERTY(VisibleAnywhere, Category="Dungeon|AI")
    int32 StartingAIToSpawn = 0;
    UPROPERTY(VisibleAnywhere, Category="Dungeon|AI")
    int32 AISpawned = 0;
    UPROPERTY(VisibleAnywhere, Category="Dungeon|Doors")
    int32 DoorsSpawned = 0;
 
    
    UPROPERTY(VisibleAnywhere, Category="Dungeon|Creation")
    bool bCreatedInEditor = false;
 
    FRandomStream RandomStream;
    FRandomStream* RandomStreamPtr = nullptr;
    
    FRandomStream NullRandomStream;
    
    TArray<IDungeonRoom*> AllDungeonRooms;
 
    
    UPROPERTY(EditAnywhere, Category="Dungeon|Optimization")
    float ExitLocationDistanceOverlap = 0.1f;
 
    // UPROPERTY(EditAnywhere, Category="Dungeon|Optimization")
    // bool bRemove = true;
 
    
    // REmove with oldFunction
    UPROPERTY(EditAnywhere, Category="Dungeon|Optimization")
    bool bDeleteExitBeforeSpawn = true;
    UPROPERTY(EditAnywhere, Category="Dungeon|Optimization", meta=(ClampMin=1, ClampMax=5))
    int32 RoomAttemptsBeforeFail = 5;
    UPROPERTY(EditAnywhere, Category="Dungeon|Optimization", meta=(ClampMin=1, ClampMax=10))
    int32 RoomAttemptsMathMultiplier = 5;
    bool bHasInvalidClass = false;
 
    
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bHideRoomRoofs = false;
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bGiveRoomsRandomStream = false;
    // Add the Start point as an exit, use when the start is a hallway etc.
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bAddStartingExit = false;
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bDebuggingMode = true;
 
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bDrawFailedExits = false;
 
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug|Log")
    bool bLogDungeonSummary = true;
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug|Log")
    bool bLogDungeonSteps = false;
 
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bResetRoomTypesOnComplete = false;
 
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bDelayEachRoomBuild = false;
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bDelayEachAISpawn = false;
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    bool bDelayEachDoorSpawn = false;
 
    // Show AI Spawn Points,
    // Show Used Spawn Points
    // Show Failed Spawn Points
 
    
    UPROPERTY(EditAnywhere, Category="Dungeon|Debug")
    float BuildDelayTime = 0.1f;
    FTimerHandle BuildDelayHandle;
 
};