InteractableComponent.h

Go to the documentation of this file.

// Copyright 2017 Blue Isle Studios, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "Runtime/CoreUObject/Public/UObject/TextProperty.h"
#include "InteractableComponent.generated.h"
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FActorHighlightSignature, APlayerController*, Sender, UPrimitiveComponent*, Component);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FActorHighlightExitSignature, APlayerController*, Sender, UPrimitiveComponent*, Component);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FActorSelectedSignature, APlayerController*, Sender, UPrimitiveComponent*, Component);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FActorHoldSelectedSignature, APlayerController*, Sender, UPrimitiveComponent*, Component);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FActorValidInteractionSignature, APlayerController*, Sender, bool, bValidInteraction);
 
UENUM(BlueprintType)
enum class EInteractionType : uint8
{
    Select = 0,
    Hold = 1,
    Both = 2
};
 
USTRUCT(Blueprintable)
struct FHighlightableComponent
{
    GENERATED_USTRUCT_BODY()
 
public:
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = HighlightableComponent)
    bool bIsHighlightable = true;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, meta = (MultiLine = "true", EditCondition = "bIsHighlightable"))
    FText HighlightText = NSLOCTEXT("ProjectX", "cmd_interact", "Interact");
};
 
UCLASS( ClassGroup=(Custom), meta=(BlueprintSpawnableComponent) )
class PROJECTX_API UInteractableComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
 
//~ Begin UActorComponent Interface
public:
    virtual void BeginPlay() override;
    virtual void Deactivate() override;
//~ End UActorComponent Interface
 
public:
    virtual bool CanSelect(APlayerController* Sender, UPrimitiveComponent* Component) const;
    bool IsValidInteraction(APlayerController* Sender) const;
 
    virtual void Select(APlayerController* Sender, UPrimitiveComponent* Component);
    virtual void HoldSelect(APlayerController* Sender, UPrimitiveComponent* Component);
    virtual void StartHold(APlayerController* Sender, UPrimitiveComponent* Component);
    virtual void ExitHold(APlayerController* Sender, UPrimitiveComponent* Component);
 
    UFUNCTION(BlueprintCallable, Category = "Interactable")
    void SetHighlightText(FText NewHighlightText);
    UFUNCTION(BlueprintCallable, Category = "Interactable")
    void SetHighlightable(bool bHighlightable);
    UFUNCTION(BlueprintCallable, Category = "Interactable")
    void SetInteractionType(EInteractionType NewInteractionType);
 
    virtual void Highlight(APlayerController* Sender, UPrimitiveComponent* Component);
    virtual void ExitHighlight(APlayerController* Sender, UPrimitiveComponent* Component);
 
    UFUNCTION(BlueprintPure, Category = "Interactable")
    bool CanHighlight(const UPrimitiveComponent* Component) const;
    UFUNCTION(BlueprintPure, Category = "Interactable")
    FText GetHighlightText(const UPrimitiveComponent* Component, const APlayerController* EventSender = NULL) const;
    UFUNCTION(BlueprintPure, Category = "Interactable")
    FORCEINLINE bool RequiresHoldInteraction() const { return InteractionType == EInteractionType::Hold; }
    UFUNCTION(BlueprintPure, Category = "Interactable")
    FORCEINLINE bool HasHoldInteraction() const { return InteractionType == EInteractionType::Hold || InteractionType == EInteractionType::Both; }
    UFUNCTION(BlueprintPure, Category = "Interactable")
    FORCEINLINE float GetHoldTime() const { return HoldDuration; }
    UFUNCTION(BlueprintPure, Category = "Interactable")
    FORCEINLINE bool CanInteract() const {  return bIsInteractable; }
    void UpdateIsInteractable(bool bCanInteract) { bIsInteractable = bCanInteract; }
 
 
public:
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorHighlightSignature OnHighlight;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorHighlightExitSignature OnHighlightExit;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorSelectedSignature OnSelected;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorHoldSelectedSignature OnHoldSelected;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorHoldSelectedSignature OnHoldStarted;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorHoldSelectedSignature OnHoldExited;
    UPROPERTY(BlueprintAssignable, Category = "Interactable Events")
    FActorValidInteractionSignature OnValidInteractionUpdatedEvent;
 
protected:
    /* Can this interactable be highlighted? */
    UPROPERTY(BlueprintReadWrite, EditDefaultsOnly, Category = "Highlight Settings", meta = (AllowPrivateAccess = true))
    bool bIsHighlightable = true;
    /* Hover text to show when this interactable is highlighted */
    UPROPERTY(BlueprintReadWrite, EditDefaultsOnly, meta = (MultiLine = "true", EditCondition = "bIsHighlightable", AllowPrivateAccess = true), Category = "Highlight Settings")
    FText HighlightText = NSLOCTEXT("ProjectX", "cmd_interact", "Interact");
    /* Does the player need to hold the button to interact? */
    UPROPERTY(BlueprintReadOnly, EditDefaultsOnly, Category = "Interactable", meta = (AllowPrivateAccess = true))
    EInteractionType InteractionType = EInteractionType::Select;
    /* How long the player must hold to pick up items */
    UPROPERTY(BlueprintReadOnly, EditDefaultsOnly, Category = "Interactable", meta = (EditCondition = "bAllowHoldInteraction", AllowPrivateAccess = true))
    float HoldDuration = 1.f;
 
    bool bIsInteractable = true;
    /* If you want highlight text to change based on which component is highlighted, define overlays here */
    UPROPERTY(BlueprintReadWrite, EditDefaultsOnly, meta = (MultiLine = "true", AllowPrivateAccess = true), Category = "Highlight Settings")
    TMap<UPrimitiveComponent*, FHighlightableComponent> PerComponentHighlightText;
 
    class UMeshComponent* Mesh;
};