HookshotComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Player/AdvancedCharacterMovement.h"
#include "PlayerStructs.h"
#include "HookshotComponent.generated.h"
 
class AProjectXCharacter;
class UPrimitiveComponent;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FHookshotUpdateSignature, const UHookshotComponent*, HookshotComponent);
 
UCLASS(ClassGroup = (Custom), meta = (BlueprintSpawnableComponent), Blueprintable)
class PROJECTX_API UHookshotComponent : public UActorComponent
{
    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;
 
    virtual void StartHookshot();
    virtual void StopHookshot();
    virtual void StartCooldown();
    virtual void SetHookshot(bool bEnable, bool bForced = false);
    virtual void OnCooldownFinished();
    virtual bool IsOnCooldown() const;
    virtual bool HasEnoughStartStamina() const;
    virtual void SetupPlayerInputComponent();
 
    UFUNCTION(BlueprintPure)
    const FVector& GetHookshotLocation() const { return HookshotLocation; }
    UFUNCTION(BlueprintPure)
    UPrimitiveComponent* GetHookedComponent() const { return HookedComponent.IsValid()? HookedComponent.Get() : NULL; }
 
    UFUNCTION()
    virtual void OnComponentHit(UPrimitiveComponent* HitComponent, AActor* OtherActor, UPrimitiveComponent* OtherComp, FVector NormalImpulse, const FHitResult& Hit);
 
    UPROPERTY(BlueprintAssignable)
    FHookshotUpdateSignature OnHookshotStart;
    UPROPERTY(BlueprintAssignable)
    FHookshotUpdateSignature OnHookshotStop;
    UPROPERTY(BlueprintAssignable)
    FHookshotUpdateSignature OnHookshotTargetAvailable;
    UPROPERTY(BlueprintAssignable)
    FHookshotUpdateSignature OnHookshotTargetNotAvailable;
 
    bool bCanUseHookshot = false;
 
protected:
    UFUNCTION()
    virtual void CheckCustomMovementToggle(ECustomMovementType CustomMovementType, bool bToggledState);
 
    //Client sends the location it feels it's hookin towards to unreliable to the server so other clients can see it as well
    UFUNCTION(Server, Unreliable)
    void Server_Unreliable_SetHookedLocation(const FVector HookedLocation);
    UFUNCTION()
    virtual void OnRep_HookedLocation();
 
protected:
    /* What is the initial energy cost of the hookshot? */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly)
    float HookshootInitialCost = 10.0f;
    /* How far can the player hookshot */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly)
    float HookshotLength = 20000.0f;
    /* Min deviation from the center of the screen a point can be to be considered as a hookable one? */
    UPROPERTY(EditDefaultsOnly)
    float MinDotAllowedOnHook = 0.9f;
    /* What is the initial energy cost of the hookshot? */
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly)
    bool bShouldHookshotResetJumpCount = false;
    /* A list of radial checks to be made from the cursor if we can't find a suitable hookshot placement.
    [100,200,400] : If we fail to find a placement near the cursor, we're going to try with a 100 radius first, then 200 and then 400 and see if we hit anything */
    UPROPERTY(EditDefaultsOnly)
    TArray<float> RangeCheckFailsafes;
 
    /* Cooldown after using the hookshot in seconds */
    UPROPERTY(EditDefaultsOnly)
    float CooldownInSeconds = 0.5f;
    /* How far from the hooked point to stop pulling the player towards the point */
    UPROPERTY(EditDefaultsOnly)
    float HookshotDisengagementDistance = 100.0f;
    bool bHookshotEnabled = false;
 
    UPROPERTY()
    AProjectXCharacter* CharacterOwner = NULL;
 
private:
    UPROPERTY(ReplicatedUsing = OnRep_HookedLocation)
    FVector HookshotLocation = FVector::ZeroVector;
    TWeakObjectPtr<UPrimitiveComponent> HookedComponent;
    float HookshotDisengagementDistanceSqrd = 0.0f;
    float CurrentMaxSpeed = 0.0f;
    FTimerHandle CooldownTimerHandle;
};