WeaponInstanceControlled.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Weapons/WeaponInstanceSpawnable.h"
#include "WeaponInstanceControlled.generated.h"
 
 class ADeployableControllable;
 
UCLASS(Blueprintable)
class PROJECTX_API UWeaponInstanceControlled : public UWeaponInstanceSpawnable
{
    GENERATED_UCLASS_BODY()
 
public:
    virtual void BeginPlay() override;
    virtual bool CanEquip() const override;
    virtual bool Equip() override;
    virtual bool CanFire(EWeaponError& ErrorMessage, uint8 Mode) const override;
    virtual bool Fire(uint8 Mode, float WorldTimeOverride) override;
    virtual bool CanUnEquip(bool bTestOnly = false) const override;
    virtual bool CanQueueUnEquip() const override;
    virtual bool UnEquip(bool bForce = false) override;
    virtual void UnEquipComplete() override;
    virtual void OwnerDied() override;
    virtual void StopAllActions() override;
 
    UFUNCTION(BlueprintPure, Category = "Controlled Weapon")
    FORCEINLINE bool IsControllingDeployable() const { return bIsControllingDeployable; }
    UFUNCTION(BlueprintPure, Category = "Controlled Weapon")
    FORCEINLINE bool IsWaitingForControlStop() const { return bIsWaitingForControlStop; }
 
protected:
    virtual void OnDeployableSpawned(ADeployable* DeployedActor) override;
    virtual void OnDeployableDestroyed(ADeployable* DeployedActor) override;
    virtual void FireComplete(uint8 Mode) override;
 
    virtual void StartDeployableControl(ADeployable* const DeployableToControl);
    virtual void OnStartDeployableControlFinished();
    virtual void StopDeployableControl(bool bForcePrematureEnd = false);
    virtual void OnStopDeployableControlFinished();
    virtual void MoveDeployablesForward(float Value);
    virtual void MoveDeployablesRight(float Value);
    virtual void MoveDeployablesUp(float Value);
 
    UFUNCTION()
    void OnDeployableDeploymentComplete(ADeployable* Deployable);
    UFUNCTION(BlueprintPure, Category = "Controlled Weapon")
    ADeployableControllable* GetCurrentlyControlledDeployable() const { return CurrentlyControllingDeployable.IsValid()? CurrentlyControllingDeployable.Get() : NULL;}
    UFUNCTION(BlueprintPure, Category = "Controlled Weapon")
    UUserWidget* GetDeployableOverlayWidget() const { return DeployableOverlayWidget.IsValid() ? DeployableOverlayWidget.Get() : NULL;}
    UFUNCTION(BlueprintCallable)
    virtual void FinishDeathAnimation();
    UFUNCTION(BlueprintImplementableEvent)
    void K2_OnDeployableControlStarted(ADeployable* Deployable);
    UFUNCTION(BlueprintImplementableEvent)
    void K2_OnDeployableControlStop();
    UFUNCTION(BlueprintImplementableEvent)
    void K2_OnDeployableControlStopFinished();
 
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    TArray<TSubclassOf<UAfflictionInstance>> AfflictionsToApplyToOwner;
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    TSubclassOf<UUserWidget> DeployableOverlayWidgetClass = nullptr;
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    float CameraBlendInTime = 0.f;
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    float CameraBlendOutTime = 0.f;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Controlled Weapon")
    float DeathAnimationDuration = 2.f;
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    bool bStopControllingOnRefire = false;
    UPROPERTY(EditDefaultsOnly, Category = "Controlled Weapon")
    bool bCanUnequipWhileDeploying = false;
    bool bIsWaitingForControlStop = false;
 
private:
    TWeakObjectPtr<UUserWidget> DeployableOverlayWidget = nullptr;
    TArray<TWeakObjectPtr<UAfflictionInstance>> AfflictionsApplied;
    FRotator CachedRotator = FRotator::ZeroRotator;
    /*This is replicated so the autonomous proxy has to wait for the server to update things correctly.
    The weapon component has some race conditions going on that might leave the server-side unsynced which might be harmful on this weapon types as it could mean inputs getting discarded
    Having this as replicated enforces that we wait for the server state to be able to control the spawned deployable */
    UPROPERTY(Replicated) 
    bool bIsControllingDeployable = false;
    TWeakObjectPtr<ADeployableControllable> CurrentlyControllingDeployable = nullptr;
    FTimerHandle DeathAnimationTimerHandle;
    
};