ActorSpawningVolume.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "Runtime/Engine/Classes/Engine/EngineTypes.h"
#include "Runtime/Core/Public/Containers/EnumAsByte.h"
#include "Components/BoxComponent.h"
#include "ReactsToMatchEvents.h"
#include "ProjectXGameMode.h"
#include "SpawnInterface.h"
#include "ActorSpawningVolume.generated.h"
 
class AStartPointVolume;
 
UCLASS()
class PROJECTX_API AActorSpawningVolume : public AActor, public IReactsToMatchEvents, public ISpawnInterface
{
    GENERATED_BODY()
    
public: 
    /* Run when the match starts, if false, the spawner will begin spawning actors immediately. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume, meta = (EditCondition = "!bExecutesOnBeginPlay"))
    bool bExecuteOnMatchStart = true; 
    /* Run when the match starts, if false, the spawner will begin spawning actors immediately. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume, meta = (EditCondition = "!bExecuteOnMatchStart"))
    bool bExecutesOnBeginPlay = false;
    /* List of possible actors to spawn. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    TArray<FActorSpawnInfo> ActorsToSpawn;
    /* Randomly chooses a value between min and max, waits that amount of time before spawning the first actor. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    FVector2D SpawnInitialDelay = FVector2D(5.0f, 10.0f);
    /* Randomly chooses a value between min and max, waits that amount of time before spawning any subsequent actors. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    FVector2D SpawnDelay = FVector2D(5.0f, 10.0f);
    /* Repeat the delay and spawn x amount of times. -1 is a infinite loop. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    int32 LoopCount = -1;
    /* Should the spawned actor be line-traced to the ground? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    bool bGroundActors = false;
    /* Should we try to snap this point to a navigable space? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume, meta = (EditCondition = "bGroundActors"))
    bool bProjectPointToNavigation = false;
    /* Which trace channel should be used? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume, meta = (EditCondition = "bGroundActors"))
    TEnumAsByte<ECollisionChannel> TraceChannel;
    /* How should we handle actors that attempt to spawn inside collision? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume, meta = (EditCondition = "bGroundActors"))
    ESpawnActorCollisionHandlingMethod SpawnCollisionHandling = ESpawnActorCollisionHandlingMethod::AdjustIfPossibleButAlwaysSpawn;
    /* After all spawning is completed, the spawner will wait this amount of time before destroying itself */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    float CleanupDelay = 1.0f;
    /* Constrains the actor spawn volume to this actor's bounds rather than using it's own. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    AActor* ActorBoundsOverride = nullptr;
    /* Match elapsed duration before the ActorBoundsOverride will be used. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    float ActorBoundsOverrideGameTime = 0.0f;
    /* Prints useful information about the state of the spawner. Does not run in ship builds. */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    bool bDebug = false;
    /* Should this actor destroy itself when spawning is completed? */
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = SpawningVolume)
    bool bDestroyWhenFinishedSpawning = true;
 
    AActorSpawningVolume();
 
    virtual void BeginSpawning_Implementation() override;
    virtual void StopSpawning_Implementation() override;
    virtual bool ImplementsSpawnCompleteCallback() const override { return true; }
 
    virtual void MatchStarted() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    virtual void BeginPlay();
    virtual bool AttemptToGroundPoint(FVector& RandomPoint, const FVector& Origin, const FVector& Extent);
    virtual void SpawningFinished();
    AStartPointVolume* GetRandomSpawnVolume() const;
    
    UFUNCTION(BlueprintImplementableEvent, Category = SpawningVolume)
    void SpawningCompleted();
 
private:
    FTimerHandle SpawnTimer;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SpawningVolume, meta = (AllowPrivateAccess = true))
    TArray<AStartPointVolume*> SpawnVolumes;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = SpawningVolume, meta = (AllowPrivateAccess = true))
    UBoxComponent* BoxComponent;
 
    int32 ChildSpawnersSpawning = 0;
    uint16 CurrentLoopCount = 0;
    TArray<FActorSpawnInfo> ActorsToSpawnCache; //We cache in case this spawner is ever to be reused
 
    FVector GetRandomPointInBox(const AActor* TransformActor, const FVector& Extent, const FVector& Origin) const;
    FVector GetSpawnPoint(AStartPointVolume* VolumeOverride = NULL) const;
 
    void SpawnActor();
    void CleanupNetObject(AActor* SpawnedActor);
    void Cleanup();
 
    UFUNCTION()
    void OnChildFinishedSpawning(UObject* Spawner);
 
    TArray<TWeakObjectPtr<AActor>> SpawnedActors;
    bool bCalledSpawnCompleteEvents = false;
};