WeaponInstanceDesignator.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "ProjectX.h"
#include "CoreMinimal.h"
#include "Engine/EngineTypes.h"
#include "Weapons/WeaponInstance.h"
#include "WeaponInstanceDesignator.generated.h"
 
UCLASS()
class PROJECTX_API UWeaponInstanceDesignator : public UWeaponInstance
{
    GENERATED_UCLASS_BODY()
    
public:
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;
 
public:
    virtual bool CanFire(EWeaponError& ErrorMessage, uint8 Mode) const override;
    virtual void EquipComplete() override;
    virtual bool UnEquip(bool bForce = false) override;
    virtual void OwnerDied() override;
    virtual bool Fire(uint8 Mode, float WorldTimeOverride = -1.f) override;
protected:
    virtual void OnRep_WeaponState(EWeaponState PreviousState) override;
    virtual void OnRep_FireCounter() override;
    virtual void StopAllActions() override;
public:
    UFUNCTION(BlueprintCallable, Category = "Designator Weapon")
    FORCEINLINE bool IsValidDesignator() const { return bValidDesignator; }
    UFUNCTION(BlueprintCallable, Category = "Designator Weapon")
    FORCEINLINE float GetDesignatorProgress() const { return ChargeValue; }
    UFUNCTION(BlueprintPure, Category = "Designator Weapon")
    FORCEINLINE UParticleSystemComponent* GetTraceParticleSystem() const { return TraceParticleSystem; }
 
protected:
    //Unreliable because this will be sent very frequently and is mostly used to just propagate this info to other clients.
    UFUNCTION(Server, Unreliable, WithValidation)
    virtual void Server_Unreliable_UpdateDesignation(const FVector& NewDesignatorLocation);
    UFUNCTION(NetMulticast, Unreliable)
    virtual void Multicast_Unreliable_UpdateDesignation(const FVector& NewDesignatorLocation);
    
    UFUNCTION(Server, Reliable, WithValidation)
    virtual void Server_Reliable_StartDesignation(const FVector& InitialDesignatorLocation);
 
    virtual void UpdateDesignator(float DeltaTime = 0.f) override;
    virtual void CompleteDesignation();
    virtual bool GetTargetTransform(FTransform& Transform) const override;
    virtual void ToggleDesignatorMarker(bool bEnable) override;
    virtual void SpawnTraceCosmetics(const FVector& EndLocation);
 
    UFUNCTION(BlueprintImplementableEvent, Category = Marker)
    void K2_OnDesignatorMarkerToggled();
 
protected:
    UPROPERTY()
    FVector DesignatorLocation = FVector(0, 0, 0);
    UPROPERTY()
    float DesignationStartTime = -1.f;
 
protected:
    //Class that is spawned when designation completes.
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    TSubclassOf<class AWeaponInstanceActor> SpawnedActorClass = NULL;
    /* Range from user that the designator can be targeted*/
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    float DesignatorRange = 100000.f;
    /* Range from user that the designator can be targeted*/
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    bool bMatchPlayerYaw = false;
    /* Emitter that should be used for the designator's trace */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Designator Weapon|Effects")
    UParticleSystem* TraceEmitter = NULL;
    /* Where on the weapon to attach the Weapon Trace Emitter */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Designator Weapon|Effects")
    FName TraceEmitterSocket = "Muzzle";
    /* Which Channel to test for desingator target position*/
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    TEnumAsByte<ECollisionChannel> DesignatorTraceChannel = ECC_WorldOnly;
    /*do you test vertically at the target location*/
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    bool bTestVertically = false;
    /* How High To test for designator End Point*/
    UPROPERTY(EditDefaultsOnly, Category = "Designator Weapon")
    float TraceHeight  = 100000.0f;
    UPROPERTY()
    class UParticleSystemComponent* TraceParticleSystem = NULL;
};