AdvancedJoystickLogic.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "JoystickLogic.h"
#include "AdvancedJoystickLogic.generated.h"
 
UENUM()
enum class ESprintLayerVisibility : uint8
{
    //Displays sprint layer when thumbstick position exceeds component size
    OutsideComponent,
 
    //Displays the sprint layer when the sprint trigger is reached
    TriggerReached,
 
    //Displays the sprint layer at the position for triggering the sprint, then at the position for triggering the automatic sprint.
    TwoStep,
 
    //Always display the sprint layer
    Always
};

UCLASS()
class TOUCHINTERFACE_API UAdvancedJoystickLogic : public UJoystickLogic
{
    GENERATED_BODY()
 
public:
    UAdvancedJoystickLogic();
    
    //Begin LayoutComponentLogic Implementation
    virtual void Initialize_Implementation() override;
 
protected:
    virtual void OnPress_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
    virtual void OnMove_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
    virtual void OnRelease_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent) override;
    virtual void OnTick_Implementation(const FGeometry& ComponentGeometry, const FPointerEvent& PointerEvent, const double InCurrentTime, const float InDeltaTime) override;
    //End LayoutComponentLogic Implementation
    
public:
    UFUNCTION(Category="Joystick|Advanced", BlueprintCallable)
    void LockThumb();

    UFUNCTION(Category="Joystick|Advanced", BlueprintCallable)
    void LockThumbAtDesiredPosition(const FVector2D LockPosition, const bool bClamp = true);

    UFUNCTION(Category="Joystick|Advanced", BlueprintCallable)
    void UnlockThumb();
 
    //Return true if auto move is enabled
    UFUNCTION(Category="Joystick|Advanced", BlueprintCallable)
    bool IsLocked() const { return bIsAutoMove; }
    
public:
    //AUTO MOVE

    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    uint8 bAutoMove:1;
    
    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    float AutoMoveThreshold;

    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.9f, UIMin=0.9f, ClampMax=1.0f, UIMax=1.0f))
    float AutoMoveDirectionThreshold;

    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float AutoMoveHoldDuration;
 
    // Decorator name for lock icon when auto move is enabled
    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly, meta=(GetOptions="GetAllDecoratorNames"))
    FName LockLayerName;
 
    // If enable, when thumbstick is locked, it is re-centred
    UPROPERTY(Category="Auto Move", EditAnywhere, BlueprintReadOnly)
    uint8 bRecenterThumbstickAfterLock:1;
 
 
    //DRAG TO SPRINT

    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    uint8 bDragToSprint:1;
    
    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float DragToSprintTrigger;

    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float DragToSprintThreshold;
 
    // Always display sprint decorator on screen
    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly)
    uint8 bAlwaysDisplaySprintLayer:1;
 
    // Sprint input action
    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly)
    UInputAction* SprintInputAction;
    
    //TODO: If sprint is launched, then stopped by out of threshold, the user's finger should back to center to relaunch sprint.
    //Avoid situation when finger is in/out of threshold value
 
    //TODO: When launched, sprint can be stopped if threshold value is exceeded
 
    UPROPERTY(Category="Drag to sprint|Auto Sprint", EditAnywhere, BlueprintReadOnly)
    uint8 bAutoSprint:1;

    UPROPERTY(Category="Drag to sprint|Auto Sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float AutoSprintTrigger;
 
    //Name of decorator used to show sprint layer button
    UPROPERTY(Category="Drag to sprint|Auto Sprint", EditAnywhere, BlueprintReadOnly, meta=(GetOptions="GetAllDecoratorNames"))
    FName SprintLayerName;
 
private:
    UPROPERTY()
    TWeakObjectPtr<UComponentDecorator> LockLayerRef;
 
    UPROPERTY()
    TWeakObjectPtr<UComponentDecorator> SprintLayerRef;
    
    float HoldDuration;
 
    uint8 bCheckHoldDuration:1;
    uint8 bIsAutoMove:1;
 
    //Thumb is locked for Auto Move
    uint8 bThumbIsLocked:1;
 
    //Direction for Auto Move
    FVector2D LockedPosition;
 
    uint8 bDragToSprintEventSent:1;
    uint8 bIsAutoSprint:1;
    
    FVector2D CurrentDragToSprintOffset;
    FName AutoSprintLayerName;
};