WeaponInstanceToggleable.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Weapons/WeaponInstance.h"
#include "WeaponInstanceToggleable.generated.h"
 
class UAfflictionInstance;
class UInteractableComponent;
class UPrimitiveComponent;
class APlayerController;
 
UENUM(BlueprintType)
enum class EToggleTrigger : uint8
{
    Fire = 0,
    EquipStart = 1,
    EquipComplete = 2,
    Custom = 3
};
 
 
UCLASS()
class PROJECTX_API UWeaponInstanceToggleable : public UWeaponInstance
{
    GENERATED_UCLASS_BODY()
    
//~ Begin UActorComponent Interface.
public:
    virtual void BeginPlay() override;
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
//~ End UActorComponent Interface.
 
//~ Begin UWeaponInstance Interface.
public:
    virtual bool CanFire(EWeaponError& ErrorMessage, uint8 Mode) const override;
    virtual bool Fire(uint8 Mode, float WorldTimeOverride = -1.f) override;
    virtual void StopAllActions() override;
    virtual void CoolDownStart(uint8 Mode);
    virtual bool Equip() override;
protected:
    virtual void FireComplete(uint8 Mode) override;
    virtual void EquipComplete() override;
    UFUNCTION()
    virtual void OnEnabledAfflictionEnded();
    virtual void ActiveTimeComplete() override;
//~ End UWeaponInstance Interface.
 
protected:
    UFUNCTION(BlueprintImplementableEvent, Category = Weapon, meta = (DisplayName = "On Activate", ScriptName = "ToggleOn"))
    void K2_ToggleOn();
    
    UFUNCTION(BlueprintImplementableEvent, Category = Weapon, meta = (DisplayName = "On Deactivate", ScriptName = "ToggleOff"))
    void K2_ToggleOff();
 
    UFUNCTION(BlueprintCallable, Category = Weapon)
    virtual void ToggleWeapon(bool bEnable);
 
    UFUNCTION(Client, Reliable)
    void Client_Reliable_ToggleOff(float FailWorldTime);
    UFUNCTION(Client, Reliable)
    void Client_Reliable_OnEnabledAfflictionEnded();
    UFUNCTION(Server, Reliable)
    void Server_Reliable_ForceToggle(bool bEnable);
 
    UFUNCTION()
    virtual void OnRep_Enabled();
 
    UFUNCTION()
    virtual void OnWeaponFire(uint8 Mode);
    UFUNCTION()
    virtual void OnHoldInteraction(UInteractableComponent* Interactable, UPrimitiveComponent* Component, float HoldTime, APlayerController* Sender);
 
protected:
    UPROPERTY()
    float LastEnableTime = -1.f;
 
    UPROPERTY(ReplicatedUsing = OnRep_Enabled)
    bool bIsEnabled = false;
 
protected:
    /*What initially triggers the toggle state of this weapon? */
    UPROPERTY(EditDefaultsOnly, Category = "Weapon|CoolDown")
    EToggleTrigger InitialToggleTrigger = EToggleTrigger::Fire;
    //Should this weapon instance toggle itself off when another weapon fires?
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon")
    bool bToggleOffOnOtherWeaponFire = false;
    //Should this weapon instance toggle itself off when interacting with objects?
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon")
    bool bToggleOffOnInteraction = false;
    /*Can Manually Toggle Off*/
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon")
    bool bCanToggleOffManually = false;
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon")
    bool bTickWhenActive = false;
    //Consume ammo on tick.
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon", meta = (EditCondition = "bTickWhenActive"))
    bool bConsumeOnTick = false;
 
    /* Affliction to be applied when weapon is active*/
    UPROPERTY(EditDefaultsOnly, Category = "Toggleable Weapon")
    TSubclassOf<UAfflictionInstance> EnabledAffliction;
};