FlagSpawn.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 "ReactsToMatchEvents.h"
#include "TeamInterface.h"
#include "SpawnTargetInterface.h"
#include "TrackableInterface.h"
#include "FlagSpawn.generated.h"
 
class AFlag;
class AProjectXCharacter;
class AProjectXPlayerState;
class USphereComponent;
class UAfflictionInstance;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FFlagSpawnEventSignature, AFlag*, Flag,bool, bNewFlag);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FFlagCarrierEventSignature,AFlag*, Flag, AProjectXCharacter*, Character, int32, Team);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FFlagStateUpdatedEventSignature, bool, bFlagIsHome);
 
UENUM()
enum class EFlagSpawnBehaviour : uint8
{
    CaptureOnly = 0,
    SpawnOnly = 1,
    Both = 2,
};
 
UCLASS()
class PROJECTX_API AFlagSpawn : public AActor, public IReactsToMatchEvents, public ITeamInterface, public ISpawnTargetInterface, public ITrackableInterface
{
    GENERATED_UCLASS_BODY()
 
    AFlagSpawn();
 
public:
    FORCEINLINE virtual int32 GetTeam() const override  { return Team; }
    virtual int32 SetTeam(int32 NewTeam) override {Team = NewTeam; return Team;}
    UFUNCTION(BlueprintCallable)
    AFlag* GetFlag() const { return Flag; }
    UFUNCTION(BlueprintCallable)
    bool IsFlagHome() const { return bFlagIsHome; }
    UFUNCTION()
    void ResetFlag(AFlag* FlagReset, AProjectXCharacter* Character, int32 FlagTeam);
    void UpdateBehaviour(EFlagSpawnBehaviour NewSpawnBehaviour){ FlagBehaviour  = NewSpawnBehaviour;}
    virtual bool CanSpawnPlayer(const AProjectXPlayerState* Instigator) const override;
    virtual float GetSpawnScoreForInstigator(const AActor* const QueryInstigator, FVector& TargetLocation, bool bUseDistanceToTargetLocation = false) const override;
 
    virtual TSoftObjectPtr<UTexture2D> GetRadarIcon() const override { return RadarIcon; }
    virtual float GetRadarIconOpacity() const { return RadarIconOpacity; }
    virtual void SetRadarIconOpacity(float Opacity) override { RadarIconOpacity = Opacity; }
    virtual bool CanFlagBeCaptured() const;
    virtual bool CanFlagBeSpawned() const;
 
    UPROPERTY(BlueprintAssignable)
    FFlagSpawnEventSignature OnFlagUpdatedEvent;
    UPROPERTY(BlueprintAssignable)
    FFlagCarrierEventSignature OnFlagCapturedEvent;
    UPROPERTY(BlueprintAssignable)
    FFlagStateUpdatedEventSignature OnFlagStateUpdatedEvent;
 
protected:  
    virtual void BeginPlay() override;
    virtual void CollectPlayerStartList();
    AFlag* SpawnFlag();
    virtual bool GetSpawnLocation(AProjectXPlayerState* Instigator, FTransform& Transform) const override;
    virtual AActor* GetPlayerStart(class AController* Player) const;
    virtual AActor* GetTrackableInterfaceActor() override { return this; }
 
    UFUNCTION(BlueprintImplementableEvent)
    void OnFlagReset();
    UFUNCTION()
    virtual void OnFlagPickedUp(AFlag* FlagPickedUp, AProjectXCharacter* Character, int32 FlagTeam);
    UFUNCTION()
    void OnRep_Flag();
    UFUNCTION()
    void OnRep_FlagState();
    UFUNCTION()
    virtual void OnOverlap(UPrimitiveComponent* OverlappedComponent, AActor* OtherActor, UPrimitiveComponent* OtherComp, int32 OtherBodyIndex, bool bFromSweep, const FHitResult& SweepResult);
 
    UFUNCTION(NetMulticast, Unreliable)
    void Multicast_OnFlagCaptured();
    UFUNCTION(BlueprintImplementableEvent)
    void OnFlagCaptured();
 
    UPROPERTY()
    TArray<AActor*> PlayerStartList;
 
    UPROPERTY(ReplicatedUsing = OnRep_FlagState)
    bool bFlagIsHome = false;
    UPROPERTY(ReplicatedUsing = OnRep_Flag)
    AFlag* Flag;
 
    /* The icon used for the flag spawn on the radar*/
    UPROPERTY(EditDefaultsOnly, Category = "Capture Point", meta = (AllowPrivateAccess = true))
    TSoftObjectPtr<UTexture2D> RadarIcon = nullptr;
    /* Use this to make the radar icon semi-transparent */
    UPROPERTY(EditDefaultsOnly, Category = "Capture Point", meta = (AllowPrivateAccess = true))
    float RadarIconOpacity = 0.3f;
    /* The maximum distance considered for awarding a score increment, every distance bigger than this value will award 0 score. Value needs to be > 0*/
    UPROPERTY(EditDefaultsOnly, Category = "Spawn Scoring", meta = (AllowPrivateAccess = true))
    float FlagSpawnDistanceScoringWeight = 10000.f;
 
    /*Class for the flag that is used*/
    UPROPERTY(EditDefaultsOnly)
    TSubclassOf<AFlag> FlagClass;
    /*Volumes for player spawns*/
    UPROPERTY(EditInstanceOnly, Category = "Capture Point Spawns")
    TArray<class AStartPointVolume*> StartPointVolumes;
    /* Team that controls the point*/
    UPROPERTY(EditInstanceOnly, Category = FlagSpawn)
    int32 Team = MAX_uint8;
    /* Sphere used to check if you scored*/
    UPROPERTY(EditDefaultsOnly)
    USphereComponent* Sphere;
    /*does the flag respawn if its captured*/
    UPROPERTY(EditDefaultsOnly)
    bool bDoesFlagResetIfCaptured = true;
    /*does the flag have to be present inorder to capture the opponents*/
    UPROPERTY(EditDefaultsOnly)
    bool bCanFlagBeCapturedWhenNotHome = false;
    /*Flags Behaviour*/
    UPROPERTY(EditDefaultsOnly)
    EFlagSpawnBehaviour FlagBehaviour = EFlagSpawnBehaviour::Both;
};