InteractionComponent.h

Go to the documentation of this file.

// Copyright 2018 Blue Isle Studios, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "InteractionComponent.generated.h"
 
class UInteractableComponent;
class APlayerController;
 
UENUM(BlueprintType)
enum class EInteractionError : uint8
{
    InteractableNotValid = 0,
    PlayerTooFar = 1
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FInteractionErrorSignature, EInteractionError, Error);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FHighlightTextSignature, FText, HighlightText, UInteractableComponent*, Interactable, UPrimitiveComponent*, Component, APlayerController*, Sender);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FHoldSignature, UInteractableComponent*, Interactable, UPrimitiveComponent*, Component, float, HoldTime, APlayerController*, Sender);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FHoldStopSignature, UInteractableComponent*, Interactable, UPrimitiveComponent*, Component, APlayerController*, Sender);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FHighlightNoTextSignature, UInteractableComponent*, Interactable, UPrimitiveComponent*, Component, APlayerController*, Sender);
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent) )
class PROJECTX_API UInteractionComponent : public UActorComponent
{
    GENERATED_BODY()
 
public: 
    /* How far can the player interact? */
    UPROPERTY(EditDefaultsOnly)
    float InteractionDistance = 500.0f;
    /* How far can the player be from the interactable on the server before the request is discarded? */
    UPROPERTY(EditDefaultsOnly)
    float ServerInteractionDistanceAllowableError = 1000.0f;
 
    UPROPERTY(BlueprintAssignable, Category = "Interaction Events")
    FHighlightTextSignature OnHighlightEnter;
    UPROPERTY(BlueprintAssignable, Category = "Interaction Events")
    FHighlightNoTextSignature OnHighlightExit;
    UPROPERTY(BlueprintAssignable, Category = "Interaction Events")
    FInteractionErrorSignature OnInteractionError;
    UPROPERTY(BlueprintAssignable, Category = "Interaction Events")
    FHoldSignature OnHoldInteraction;
    UPROPERTY(BlueprintAssignable, Category = "Interaction Events")
    FHoldStopSignature OnHoldInteractionStop;
 
    void UpdateCanInteract(bool bNewCanInteract);
 
    bool HasValidInteractionTarget() const;
 
private:
    friend class AProjectXCharacter;
 
    FTimerHandle HoldTimerHandle;
    UInteractableComponent* TargetCache;
    mutable APlayerController* PlayerController;
 
    UInteractionComponent();
 
    APlayerController* GetPlayerController() const;
    FHitResult FindTargetInteractable() const;
    void GetTarget(UInteractableComponent*& Target, UPrimitiveComponent*& TargetComponent) const;
 
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
    UFUNCTION()
    void Interact();
    UFUNCTION()
    void StopInteract();
    UFUNCTION()
    void FinishHoldInteract(UInteractableComponent* HitInteractable, UPrimitiveComponent* HitComponent);
    UFUNCTION()
    void ClearHoldInteract();
 
    void HoldInteract(UInteractableComponent* Target,UPrimitiveComponent* HitComponent);
    bool IsValidInteraction(const UInteractableComponent* HitInteractable, UPrimitiveComponent* HitComponent, const bool bDisplayErrors = true) const;
    UFUNCTION(Reliable, Server, WithValidation)
    void Server_Select(UInteractableComponent* HitInteractable, UPrimitiveComponent* HitComponent);
    UFUNCTION(Reliable, Server, WithValidation)
    void Server_Hold(UInteractableComponent* HitInteractable, UPrimitiveComponent* HitComponent);
    UFUNCTION(Reliable, Server, WithValidation)
    void Server_StopHold();
 
    bool bCanInteract = true;
};