CharacterGrabberComponent.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/CharacterComponent.h"
// #include "Data/InteractionData.h"
#include "CharacterGrabberComponent.generated.h"
 
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnPickupActor, bool, bPickedUp);
DECLARE_LOG_CATEGORY_EXTERN(LogGrabberComponent, Display, All);
 
//@ TODO in Grabber,
// Replicated = Mostly Complete
// Zoom not Replicated  
// Rotation Needs to be completed,
// Snapping to be completed, Check out Synty Project for Snapping
//UE5_ALSv4_Synty
// Items should check to see what "type" the object they're going to stick to is.
// e.g. Huge box can't attach to tiny Gun.
// if we're in Rotation Mode - should player be able to move there mouse/Stick, or only rotate item
 
 
UCLASS(Blueprintable, BlueprintType, ClassGroup=(BucciGames), meta=(BlueprintSpawnableComponent))
class INTERACTION_API UCharacterGrabberComponent : public UCharacterComponent
{
    GENERATED_BODY()
 
public:
    UCharacterGrabberComponent();
 
    UPROPERTY(BlueprintAssignable, Category="Grabber")
    FOnPickupActor OnPickupActor;
    
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void SetGrabbedComponent(const FVector& Location, const FRotator& Rotation) const;
    
    void SetThrowStrength(const float Strength){ThrowStrength = Strength;};
    UFUNCTION(BlueprintCallable, Category="Grabber")
    UPrimitiveComponent* GetGrabbedComponent() const;
 
    UFUNCTION(BlueprintPure, BlueprintCallable, Category="Grabber")
    bool GetIsHoldingActor() const;
 
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void GrabActor(const FHitResult& HitResult);
    UFUNCTION(Server, Reliable, Category="Grabber")
    void Server_GrabActor(const FHitResult& HitResult);
 
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void PickupActorFromInteraction();
 
    UFUNCTION(Server, Reliable, Category="Grabber")
    void GrabTick();
    
    UFUNCTION(Server, Reliable, BlueprintCallable, Category="Grabber")
    void Server_DropActor();
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void DropActor();
 
    UFUNCTION(Server, Reliable, BlueprintCallable, Category="Grabber")
    void Server_ThrowActor(const float ForceMultiplier = 1.0f);
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void ThrowActor(const float ForceMultiplier = 1.0f);
 
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void SetGrabDistance(const float Distance);
    UFUNCTION(BlueprintPure, BlueprintCallable, Category="Grabber")
    float GetGrabDistance()const {return GrabDistance;};
 
    //~     Object Rotation     ~//
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void RotateObjectXAxis(const float Value);
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void RotateObjectYAxis(const float Value);
    // UFUNCTION(BlueprintCallable, Category="Grabber")
    // void ToggleRotationMode();
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void SetGrabberRotationMode(const bool bTurnOn);
 
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void ResetRotation();
    //~     Object Zoom     ~//
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void ZoomObject(const float Value);
    UFUNCTION(Server, Reliable, Category="Grabber")
    void Server_ZoomObject(const float Value);
 
    UFUNCTION(BlueprintCallable, Category="Grabber")
    bool GetIsInRotationMode() const {return bRotationMode;};
    
    FVector GetTargetLocation() const {return TargetLocation;};
    FVector GetAttachPointLocation() const
    {
        if(IsActive() == false){return FVector::ZeroVector;}
        if(AttachPoint == nullptr){LogDebugError("GetAttachPointLocation, AttachPoint");return FVector::ZeroVector;}
        return AttachPoint->GetComponentLocation();
    }
 
protected:
    virtual void BeginPlay() override;
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
    virtual void ComponentSetupComplete() override;
    virtual void ComponentDeactivated(UActorComponent* Component) override;
 
    UFUNCTION(Server, Reliable, Category="Grabber")
    void Server_PickupActor(const FName BoneName, const FVector Location, const FRotator Rotation);
    UFUNCTION(BlueprintCallable, Category="Grabber")
    void PickupActor(const FName BoneName, const FVector Location, const FRotator Rotation);
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bLogTick = false;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bSetRotation = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bUseNormalTick = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bAddStartRotation = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bSetRotationZero = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bOverrideMass = false;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging", meta=(EditCondition=bOverrideMass))
    float NewMass = 0.5f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Debugging")
    bool bShowTraceLocations = false;
 
    //- Additional/Less distance for Grabbing   //
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    float GrabDistanceAddition= -30.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    float GrabLocationOffset = 120.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    float GrabUpdateTick = 0.01f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    bool bUseCameraLocation = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    bool bUsePlayerOffset = true;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|General")
    bool bUsePlayerRotation = true;
 
    
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Physics")
    float LinearDamping = 200.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Physics")
    float LinearStiffness = 1750.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Physics")
    float AngularDamping = 500.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Physics")
    float AngularStiffness = 1500.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Physics")
    float InterpolationSpeed = 1000.0f;
 
 
    //~ Zoom Vars   ~//
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Zoom")
    float ZoomSpeed = 10.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Zoom")
    float ZoomClampMin = 50.0f;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Zoom")
    float ZoomClampMax = 150.0f;
    UPROPERTY(Replicated, EditAnywhere, BlueprintReadOnly, Category="Grabber|Zoom")
    float ZoomValue = 150.0f;
    float ZoomValueDefault = 0.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Rotate")
    bool bUseRotateLerp = false;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Rotate", meta=(ClampMin=0.0f, ClampMax=1.0f))
    float SmoothAutoRotation = 0.4;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Rotate")
    float RotationModeSensitivity = 150.0f;
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Rotate")
    bool bYRotationDisabled = false;
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Rotate")
    bool bXRotationDisabled = false;
 
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Snapping")
    TEnumAsByte<ECollisionChannel> SnapTraceChannel;
    // UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Grabber|Snapping")
    // float SnapTraceLengthMultiplier = 1.0f;
    
private:
    void ResetValues();
    FVector GetThrowForce(const float Multiplier) const;
    FRotator GetRotation() const;
    FVector GetLocation() const;
 
    UFUNCTION(Server, Reliable, Category="Grabber")
    void Server_SetGrabDistance(const float Distance);
 
    void SnapLineTrace();
    void DrawSnapStatus(const FVector& Location) const;
 
 
    bool GetPhysicsComponent(const AActor* Actor);
    bool GetPhysicsActor(AActor* Actor);
 
    UFUNCTION()
    void OnRep_CanSnap();
 
 
    UPROPERTY(Replicated, VisibleAnywhere, Category="Grabber|Status")
    bool bHoldingActor = false;
    UPROPERTY(Replicated, VisibleAnywhere, Category="Grabber|Status")
    bool bRotationMode = false;
    UPROPERTY(Replicated, VisibleAnywhere, Category="Grabber|Status")
    float GrabDistance = 500.0f;
    UPROPERTY(ReplicatedUsing=OnRep_CanSnap, VisibleAnywhere, Category="Grabber|Status")
    bool bCanSnap = false;
    
    class IPhysicsPickup* PhysicsPickup = nullptr;
    
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status")
    FVector TargetLocation = FVector::ZeroVector;
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status")
    FName TargetBone = NAME_None;
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status")
    FRotator CurrentHeldRotation = FRotator::ZeroRotator;
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status")
    FVector LastHeldLocation = FVector::ZeroVector;
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status")
    float TraceDistanceMin = 10.0f;
    
    FRotator PendingRotationDelta;
    float RotationInputBufferTime = 0.0f;
    const float RotationApplyRate = 1.0f / 20.0f; // 20 times/sec (50ms)
 
    UFUNCTION(Server, Unreliable)
    void Server_ApplyRotationDelta(FRotator Delta);
    void ApplyRotationDelta(const FRotator& Delta);
 
    UPROPERTY(Replicated, VisibleAnywhere, Category="Grabber|Status|Components")
    class UPrimitiveComponent* TargetComponent = nullptr;
    UPROPERTY(VisibleAnywhere, Category="Grabber|Status|Components")
    class UPrimitiveComponent* TargetComponentAttach = nullptr;
 
 
    UPROPERTY(Replicated)
    class UPhysicsHandleComponent* PhysicsHandleComponent;
    UPROPERTY(Replicated)
    class USceneComponent* AttachPoint = nullptr;
    
    float ThrowStrength = 500.0f;
    
    UPROPERTY()
    FHitResult LastHitResult;
    
    FTimerHandle GrabTickTimerHandle;
};