SpawnTargetInterface.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Interface.h"
#include "SpawnTargetInterface.generated.h"
 
class AProjectXPlayerState;
 
UINTERFACE(meta=(CannotImplementInterfaceInBlueprint))
class USpawnTargetInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class PROJECTX_API ISpawnTargetInterface
{
    GENERATED_IINTERFACE_BODY()
 
public:
    virtual void RegisterActorForScoring();
    virtual void DeRegisterActorForScoring();
    //Returns true if this target can be spawned on by a given instigator.
    UFUNCTION(BlueprintCallable, Category = SpawnTargetInterface)
    virtual bool CanSpawnPlayer(const AProjectXPlayerState* Instigator) const { return false; }
 
    //Returns transform for an actor to use when spawning on this actor. bValid will be true if the given FTransform is a valid one. Implementations may return different FTransforms every call.
    UFUNCTION(BlueprintCallable, Category = SpawnTargetInterface)
    virtual bool GetSpawnLocation(AProjectXPlayerState* Instigator, FTransform& Transform) const { return false; }
    //Returns a score for spawn systems so that each actor can 
    UFUNCTION(BlueprintCallable, Category = SpawnTargetInterface)
    virtual float GetSpawnScoreForInstigator(const AActor* const QueryInstigator, FVector& TargetLocation, bool bUseDistanceToTargetLocation = false) const { return 0.f; }
    UFUNCTION(BlueprintCallable, Category = SpawnTargetInterface)
    virtual bool GetCanSpawnOnCombatTarget() const { return false; }
    virtual void UpdateCanSpawnOnCombatTarget(bool bNewInCombatSpawnTarget) {}
    static const void GetAverageEnemyTeamLocation(const UObject* Caller, TArray<AActor*>& AvailableSpawnPoints, FVector& AverageEnemyLocation);
    static AActor* GetFurthestLocationFromOtherPlayers(const UObject* Caller, TArray<AActor*>& AvailableSpawnPoints);
    static AActor* GetRandomSafeSpawnLocation(const UObject* Caller, TArray<AActor*>& AvailableSpawnPoints, float MaximumSpawnDistance, float MinimumSpawnDistance);
    virtual bool ShouldRegisterForScoringOnStart() const { return true; }
};