VirtualInputDragToSprint.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "VirtualInputEvent.h"
#include "VirtualInputDragToSprint.generated.h"
 
class UVirtualInputButton;
class SVirtualControlJoystick;
class UVirtualInput;

UCLASS(Abstract, MinimalAPI)
class UVirtualInputDragToSprint : public UVirtualInputEvent
{
    GENERATED_BODY()
 
public:
    // The minimum drag length in pixel (Y axis, vertical) to start the sprint
    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float DragToSprintTrigger = 150.0f;

    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float DragToSprintThreshold = 40.0f;

    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly)
    TObjectPtr<UVirtualInputButton> SprintButton;
 
    // Always displayed on screen
    UPROPERTY(Category="Drag to sprint", EditAnywhere, BlueprintReadOnly)
    bool bAlwaysDisplaySprintButton = false;
 
    
    
    //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="Auto Sprint", EditAnywhere, BlueprintReadOnly)
    bool bEnableAutoSprint = true;

    UPROPERTY(Category="Auto Sprint", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float AutoSprintTrigger = 400.0f;
 
    // Auto sprint icon (displayed on joystick)
    UPROPERTY(Category="Auto Sprint", EditAnywhere, BlueprintReadOnly)
    FVisualLayer AutoSprintIcon;
 
    //TODO: Sprint Mode: Inject input, increase raw value of virtual input or send event?
 
    //TODO: Allow user to make more advanced customization with subclass (show example)
 
    //TODO: Detect sprint in any direction?
 
    virtual bool IsCompatible(EControlType InputType) const override { return InputType == EControlType::Joystick; }
 
private:
    TSharedPtr<SVirtualControlJoystick> Joystick;
 
    TArray<FVisualLayer> SprintButtonVisualLayers;
 
    UPROPERTY()
    UInputAction* SprintButtonInputAction;
    
    uint8 bDragToSprintEventSent:1;
    uint8 bIsAutoSprint:1;
    
    FVector2D CurrentDragToSprintOffset;
 
    FName SprintLayerName;
    FName AutoSprintLayerName;
 
protected:
    virtual void Initialize_Implementation() override;
    virtual void OnTouchBegin_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime) override;
    virtual void OnTouchMove_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration) override;
    virtual void OnTouchEnd_Implementation(const FGeometry& Geometry, const FPointerEvent& PointerEvent, const float CurrentTime, const float PressDuration) override;
};