SpottingComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "ProjectX.h"
#include "Components/ActorComponent.h"
#include "SpottingComponent.generated.h"
 
class ACharacter;
class AController;
class UAfflictionInstance;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FEnemySpottedSignature, AActor*, EnemySpotted);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FEnemyUniqueEnemySpottedSignature);
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent), Blueprintable)
class PROJECTX_API USpottingComponent : public UActorComponent
{
    GENERATED_BODY()
 
public: 
    USpottingComponent();
    virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    bool IsEnabled() const { return bSpottingComponentEnabled; }
    float GetCachedSpottingRange() const { return CachedSpottingDistance; }
 
    UFUNCTION(BlueprintCallable)
    void SetDotMultiplier(float NewMultipler) { MaxDotMultiplier  = NewMultipler;}
    UFUNCTION(BlueprintCallable, Category = "Spotting Component")
    void SetOwningCharacter(ACharacter* const InOwningCharacter);
    UFUNCTION(BlueprintCallable, Category = "Spotting Component")
    void PerformRadialScan(float ScanRange, bool bIgnoreObstacles = false, bool bRevealStealthTargets = false);
    UFUNCTION(BlueprintCallable, Category = "Spotting Component")
    void UpdateSpottingRange(float NewRange) { SpottingRange = NewRange; }
    UFUNCTION(BlueprintCallable, Category = "Spotting Component")
    void UpdateUseDotProductCheck(bool bNewCheckDotProduct) { bCheckDotProduct = bNewCheckDotProduct;}
 
    FEnemySpottedSignature OnEnemySpotted;
    FEnemyUniqueEnemySpottedSignature OnUniqueEnemySpotted;
 
protected:
    UFUNCTION(BlueprintPure, Category = "Spotting Component")
    virtual ACharacter* GetOwningCharacter() const;
    UFUNCTION(BlueprintPure, Category = "Spotting Component")
    AController* GetOwningController() const;
 
    // Called when the game starts
    virtual void BeginPlay() override;
    //UPROPERTY(ReplicatedUsing = OnRep_SpottingEnabled)
    bool bSpottingComponentEnabled = true;
    /* affliction appled to affected players */
    UPROPERTY(EditDefaultsOnly, Category = Radar)
    TSubclassOf<UAfflictionInstance> SpottedAffliction = NULL;
    /* Time in seconds required while holding the cursor on top of an actor to spot it */
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    float SpottingRequiredTime = 3.f;
    /* The max range at which this component will scan for spotting in cms*/
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    float SpottingRange = 1000000.f;
    /* A curve that lays out the max dot a target can be from the spotter based on distance. As the distance grows so does your vision cone, this helps you to tighten up that dot so you can remain precise even when testing against distant targets*/
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    UCurveFloat* MaxDotPerDistanceCurve = nullptr;
    /* A multiplier that can be set to the dot check at runtime */
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    float MaxDotMultiplier = 1.f;
    /* Should we run the target finder on the server ? */
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    bool bTickTargetFinderOnServer = false;
    /* Should the spotted character be revelead if he is invisible ? */
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    bool bRevealInvisibleTargets = false;
    /* Can this spotting component spot multiple targets at once? Have in mind that Multispots don't use SpottingRequiredTime but are rather spotted instantly to avoid keeping track of multiple possible targets at once. Multiple spot events can only occur when
    this component ticks on the server*/
    UPROPERTY(EditDefaultsOnly, Category = "Spotting Component")
    bool bCanMultispot = false;
 
    TWeakObjectPtr<AActor> SpottingTarget = NULL;
    UPROPERTY()
    ACharacter* OwningCharacter = NULL;
    
    void TickTargetFinder(float DeltaTime);
    void TickTargetMaintain(float DeltaTime);
    void SpotTarget(AActor* SpottedActor, int& UniqueSpots);
 
    UFUNCTION(Server, Reliable, WithValidation)
    void Server_SpotTarget(AActor* SpottedActor);
 
    UFUNCTION(BlueprintNativeEvent, Category = "Spotting Component")
    void GetSpottingViewPoint(FVector& OutLocation, FRotator& OutRotation) const;
private:
    UPROPERTY(Transient)
    float SpottingTime = 0.f;
 
    bool bCheckDotProduct = true;
    float CachedSpottingDistance = 0.0f;
};