ProjectXAISpawner.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2017. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "ReactsToMatchEvents.h"
#include "SpawnInterface.h"
#include "ProjectXAISpawner.generated.h"
 
class AProjectXCharacter;
class APlayerState;
 
UCLASS()
class PROJECTX_API AProjectXAISpawner : public AActor, public IReactsToMatchEvents, public ISpawnInterface
{
    GENERATED_BODY()
    
public:
    /*Execute this spawner immediately rather than on match start?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config", meta=(EditCondition = "!bExecuteImmediately"))
    bool bExecuteOnMatchStart = true;
    /*Execute this spawner immediately rather than on match start?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    bool bExecuteImmediately = false;
    /*What Team should this AI spawn on?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    int32 Team = 99;
    /*Which AI would you like to spawn here?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Spawn Config")
    TSubclassOf<class AProjectXCharacter> AIToSpawn;
    /*How long should the AI take to spawn once the game starts?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    float SpawnDelay = 0.0f;
    /*Once this AI spawns, how long does it stay alive? -1 means infinite duration. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    float LifeTime = -1.0f;
    /*Should the AI respawn if killed?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    bool bRespawn;
    /*How long should the AI take to respawn?*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config", meta = (EditCondition = "bRespawn"))
    float RespawnTime = 60.0f;
    /*How many players must be playing for this AI to spawn? If the playercount falls below this threshold, the AI will despawn. -1 Will always spawn and never despawn. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    int32 RequiredPlayerCount = INDEX_NONE;
    /*Should thie spawner auto destroy if possible once spawning is completed? Some things prevent auto-destruction such as lifetime and respawn settings */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    bool bAutoDestroy = true;
    /*Should we despawn the AI when stopspawning is called? */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    bool bDespawnAIWhenStopSpawningCalled = false;
    /*If the player count is specified, its associative multiplier will be used to increase or decrease spawned health */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Spawn Config")
    TMap<int32, float> PlayerCountHealthMultipliers;
 
    TWeakObjectPtr<AProjectXCharacter> SpawnedAI = nullptr;
 
    FTimerHandle AIRespawnTimer;
 
    AProjectXAISpawner();
 
    UFUNCTION(BlueprintImplementableEvent)
    void OnAISpawned(AProjectXCharacter* SpawnedActor);
 
    virtual void BeginSpawning_Implementation() override;
    virtual void StopSpawning_Implementation() override;
    virtual bool ImplementsSpawnCompleteCallback() const override;
    virtual void Despawn();
    virtual void Cleanup();
 
    FORCEINLINE bool ShouldDestroySpawnerOnceComplete() const { return bAutoDestroy && LifeTime == -1.0f && !bRespawn; }
 
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    virtual void MatchStarted() override;
    virtual void HandleSpawn();
    
    UFUNCTION()
    virtual void OnAIDeath(AActor* Victim, const float Damage, struct FDamageEvent const& DamageEvent, const AController* EventInstigator, const AActor* DamageCauser, const class APlayerState* InstigatorPlayerState);
};