RoomActor.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 "GameFramework/Actor.h"
#include "Interfaces/DungeonRoom.h"
#include "RoomActor.generated.h"
 
class UBoxComponent;
 
UCLASS()
class PROCEDURALDUNGEONS_API ARoomActor : public AActor, public IDungeonRoom
{
    GENERATED_BODY()
 
public:
    ARoomActor();
 
 
protected:
    virtual void BeginPlay() override;
    
    UFUNCTION(BlueprintNativeEvent, Category="Room")
    bool GetShouldRoomSpawnDoor(const FRandomStream& Stream) const;
 
    // UFUNCTION(BlueprintCallable, Category="Room|Random")
    // void ShowBounds() const {return RandomStream;};
 
    //@ TODO Spawn all Rooms, Then Trace out to see if a Window can be put on each side
    UFUNCTION(BlueprintCallable, Category="Room")
    bool GetCanHaveWindow() const;
    
    UFUNCTION(CallInEditor, Category="Room|Editor")
    void HideRoof();
    UFUNCTION(BlueprintCallable, Category="Room|Random")
    FRandomStream GetRandomStream() const {return RandomStream;};
    UFUNCTION(BlueprintCallable, Category="Room|Random")
    bool GetIsRandomStreamSet() const {return bRandomStreamSet;};
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|General")
    EDungeonRoomType RoomType = EDungeonRoomType::Hallway;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Doors")
    bool bShouldDoorSpawn = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Doors", meta=(EditCondition="bShouldDoorSpawn"))
    bool bRandomDoorSpawn = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Doors", meta=(EditCondition="bRandomDoorSpawn", ClampMin=0.0f, ClampMax=1.0f))
    float RandomWeight = 0.5f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Windows")
    bool bCheckForWindow = false; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Windows")
    float WindowTraceDistance = 2000.0f;
 
    // UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Room|Debug")
    // bool bGetRandomStreamAtBegin = true;
 
    
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* DefaultRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* ExitsRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* OverlapsRootComponent;
    //~     Spawners    //
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* AISpawnsRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* WeaponSpawnsRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* LootSpawnsRootComponent;
    //~     Spawners    //
    
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* DoorsRootComponent;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* LightsRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* GeometryRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* WallsRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* RoofRootComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* FloorRootComponent;
    // Static Decorations
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* DecorationsRootComponent;
    // Used for any Physics objects (Currently Only Static Meshes)
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    USceneComponent* PropsRootComponent;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    UBoxComponent* BoundsComponent;
 
    //Furniture: Chairs, tables, shelves, beds, etc., which add to the room's atmosphere.
    //Props: Miscellaneous items like barrels, crates, tools, books, or artifacts that make the room feel lived-in or used.
 
    //Paintings/Posters/Signs: Wall decorations that add narrative or thematic elements to the room.
    //Lighting: Placement for lights, torches, lamps, chandeliers, or other sources of light.
    //Event Triggers: Specific spots that trigger events, such as spawning enemies, activating traps, or starting a timer.
    //Enemy Patrol Routes: Waypoints or paths that enemies can follow, making AI behavior more dynamic.
    //Turrets/Defensive Structures: Fixed defensive emplacements that can add strategic depth to combat encounters.
    //Health Stations/Refill Points: Areas where players can restore health, mana, or other resources.
 
    //Ambient Sounds: Placement for sound emitters that create ambient noises like wind, dripping water, or distant machinery.
    //Save Points/Checkpoints: Areas where the player can save their progress or respawn after death.
 
    //Boss Arena Features: Special setups for boss encounters, such as central platforms, escape routes, or hazard zones.
    //Cover Points: Specific locations where AI or players can take cover during combat.
    //Lore Objects: Books, scrolls, or other items that players can interact with to learn more about the world’s lore.
    //NPCs: Placement for non-combat characters who could provide quests, information, or trading opportunities.
    // UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Component")
    // USceneComponent* HazzardsRootComponent;
    // Puzzle Elements
    //Spawn Zones: Areas for spawning environmental hazards like fire, poison gas, or lightning.
    // Traps
    // Secrets
    // Dynamic Elements: Moving platforms, elevators, or rotating walls that could add to the room's complexity.
 
    //@ TODO These should get TArray<> of StaticMeshComponents? save casting each time,
    //only do it once on begin play if works in time with builder?
    virtual USceneComponent* GetExitsRootComponent() const override {return ExitsRootComponent;};
    virtual USceneComponent* GetOverlapsRootComponent() const override {return OverlapsRootComponent;};
    virtual USceneComponent* GetAISpawnsRootComponent() const override {return AISpawnsRootComponent;};
    virtual USceneComponent* GetWeaponSpawnsRootComponent() const override {return WeaponSpawnsRootComponent;};
    virtual USceneComponent* GetLootSpawnsRootComponent() const override {return LootSpawnsRootComponent;};
    virtual USceneComponent* GetDoorsRootComponent() const override {return DoorsRootComponent;};
    virtual int32 GetNumOfExits() const override;
 
    virtual FBox GetRoomBounds() const override;
    virtual EDungeonRoomType GetRoomType() const override {return RoomType;};
 
    virtual bool GetShouldRoomSpawnDoorAtEntry(const FRandomStream& Stream) const override {return GetShouldRoomSpawnDoor(RandomStream);};
    virtual void AddAttachedRoom(AActor* Actor) override;
    virtual void ToggleAllRoomRoofs(const bool bForceHide) override;
 
    //@Test which is more Efficient //
    virtual void SetRandomStream(const FRandomStream& Stream) override;
 
    virtual void SetDynamicMaterial(UMaterialInterface* Material) override;
 
    // @TODO optimization Interface in BaseHelpers, Use for All Objects, etc.
    
    //- Optimization Functions //
    virtual void SetActive(const bool bActive) override;
    
    // @TODO Optimization Levels
    // Level 0 - No Optimizations
    // Level 1 - Physics objects off - Decorations off
    // Level 2 - Lights off
    // Level 3 - All Meshes not Visible
    virtual void SetOptimizationLevel(const int32 Level) override;
    UFUNCTION(BlueprintImplementableEvent, Category="Optimization")
    void OnOptimizationLevelChanged(const int32 Level, const int32 PreviousLevel);
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    int32 GetOptimizationLevel() const {return OptimizationLevel;}
 
    virtual void SetReady() override;
    UFUNCTION(BlueprintImplementableEvent, Category="Room")
    void OnRoomReady();
    UFUNCTION(BlueprintCallable, Category="Room")
    bool GetIsRoomReady() const {return bReady;};
 
    
    virtual void Activate();
    virtual void Deactivate();
 
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void ToggleLights(const bool bTurnOn) const;
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void TogglePhysicsObjects(const bool bSimulatePhysics, const bool bVisible) const;
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void TogglePhysicsObjectsSimulation(const bool bSimulatePhysics) const;
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void TogglePhysicsObjectsVisibility(const bool bVisible) const;
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void ToggleGeometry(const bool bVisible) const;
    UFUNCTION(BlueprintCallable, Category="Room|Optimization")
    void ToggleDecorations(const bool bVisible) const;
    // virtual void AddAttachedRoomFromExit(USceneComponent* Exit) override;
 
 
    UFUNCTION(BlueprintCallable, Category="Room")
    bool GetCanBeWindow(UStaticMeshComponent* WallMesh) const;
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Room|Debug")
    bool bDebuggingMode = false;
 
    
    //@ TODO Move to Private
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Connections")
    TArray<ARoomActor*> AttachedRooms;
    // @TODO Optimize Door Actors, Are there Multiple rooms that have the same door? 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="Room|Doors")
    TArray<AActor*> DoorActors;
 
private:
 
    void GetLightComponents();
    void GetPropComponents();
 
    UPROPERTY(VisibleAnywhere, Category="Room|General")
    bool bReady = false;
    
    UPROPERTY(VisibleAnywhere, Category="Room|Random")
    bool bRandomStreamSet = false;
    UPROPERTY(VisibleAnywhere, Category="Room|Random")
    FRandomStream RandomStream;
    UPROPERTY(VisibleAnywhere, Category="Room|Random")
    int32 Seed = 0;
 
    UPROPERTY(VisibleAnywhere, Category="Room|Debug")
    bool bShouldHideRoof = false;
    UPROPERTY(VisibleAnywhere, Category="Room|Optimization")
    int32 OptimizationLevel = 0;
    UPROPERTY(VisibleAnywhere, Category="Room|Optimization")
    int32 PreviousOptimizationLevel = 0;
 
 
    UPROPERTY(VisibleAnywhere, Category="Room|Lights")
    TArray<ULightComponent*> Lights;
    UPROPERTY(VisibleAnywhere, Category="Room|Props")
    TArray<UStaticMeshComponent*> Props;
 
};