SpottableInterface.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "ProjectX.h"
#include "UObject/Interface.h"
#include "SpottableInterface.generated.h"
 
UINTERFACE(BlueprintType, meta = (CannotImplementInterfaceInBlueprint))
class USpottableInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
UENUM(BlueprintType)
enum class ESpotType : uint8
{
    HUD = 0,
    Radar = 1,
    All = 2,
    None = 255
};
 
UENUM(BlueprintType)
enum class ESpotReply : uint8
{
    Valid = 0,
    Invalid = 1,
    Invisible = 2,
    None = 255
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FSpottedSignature);
DECLARE_DYNAMIC_DELEGATE(FBPSpottedSignature);
 
class PROJECTX_API ISpottableInterface
{
    GENERATED_IINTERFACE_BODY()
 
    FSpottedSignature InterfaceOnSpottedStartEvent;
    FSpottedSignature InterfaceOnSpottedEndEvent;
 
public:
    /* Returns true if this actor can be spotted by the SpotInstigator */
    UFUNCTION(BlueprintCallable, Category = SpottableInterface)
    virtual ESpotReply CanBeSpotted(const AActor* SpotInstigator, ESpotType SpotType) const { return ESpotReply::Valid; }
 
    UFUNCTION(BlueprintCallable, Category = SpottableInterface)
    virtual FVector GetSpottingTraceOffset() const { return FVector::ZeroVector; }
 
    UFUNCTION(Category = "SpottableInterface Events")
    virtual FSpottedSignature& GetSpottedStartEvent() { return InterfaceOnSpottedStartEvent; }
    UFUNCTION(Category = "SpottableInterface Events")
    virtual FSpottedSignature& GetSpottedStopEvent() { return InterfaceOnSpottedEndEvent; }
 
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void BroadcastSpottedEvent() { InterfaceOnSpottedStartEvent.Broadcast(); }
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void BroadcastSpottedEndEvent() { InterfaceOnSpottedEndEvent.Broadcast(); }
 
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void BindToSpottedEvent(const FBPSpottedSignature& Event) { InterfaceOnSpottedStartEvent.Add(Event); }
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void BindToSpottedEndEvent(const FBPSpottedSignature& Event) { InterfaceOnSpottedEndEvent.Add(Event); }
 
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void UnBindToSpottedEvent(const FBPSpottedSignature& Event) { InterfaceOnSpottedStartEvent.Remove(Event); }
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void UnBindToSpottedEndEvent(const FBPSpottedSignature& Event) { InterfaceOnSpottedEndEvent.Remove(Event); }
 
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void ClearAllSpottedEvents() { InterfaceOnSpottedStartEvent.Clear(); }
    UFUNCTION(BlueprintCallable, Category = "SpottableInterface Events")
    virtual void ClearAllSpottedEndEvents() { InterfaceOnSpottedEndEvent.Clear(); }
 
    
};