TrackableInterface.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "ProjectX.h"
#include "UObject/Interface.h"
#include "TrackableInterface.generated.h"
 
class UMapMarkerComponent;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FStopTrackingActorSignature,const AActor*, Actor);
 
UINTERFACE(BlueprintType, meta = (CannotImplementInterfaceInBlueprint))
class PROJECTX_API UTrackableInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class PROJECTX_API ITrackableInterface
{
    GENERATED_IINTERFACE_BODY()
public:
    virtual void BroadcastTrackableActor();
    virtual FStopTrackingActorSignature& GetStopTrackingEvent() { return StopTrackingEvent; }
 
    //Returns the Owner's Icon to be displayed on the map (Deploy screen).
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual TSoftObjectPtr<UTexture2D> GetMapIcon() const { return NULL; }
    //Returns the Owner's Icon to be displayed on the map (Deploy screen).
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual TSoftObjectPtr<UTexture2D> GetRadarIcon() const { return NULL; }
    //Returns the Owner's Icon to be displayed on the HUD
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual TSoftObjectPtr<UTexture2D> GetHudIcon() const { return NULL; }
    //Returns the actor that implements this interface
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual AActor* GetTrackableInterfaceActor() {return NULL;}
    //Returns the Owner's desired radar icon size 16.0f means default (unchanged)
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual float GetRadarIconSize() const { return 2000.0f; }
    //Returns the Owner's desired radar icon opacity, 1.0f means default (unchanged)
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual float GetRadarIconOpacity() const { return 1.0f; }
    //Returns the Owner's desired radar icon opacity when as enemy, returns GetRadarIconOpacity as default (unchanged)
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual float GetRadarIconEnemyOpacity() const { return GetRadarIconOpacity(); }
    //Returns if this actor's icon should compensate for the player rotation
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual bool GetRadarIconCompensantesRotation() const { return false; }
    UFUNCTION(BlueprintCallable)
    virtual bool GetAllyVisibilityResponse() { return GetTrackableInterfaceActor() ? GetTrackableInterfaceActor()->CanBeDamaged() : false;}
    //Allows for custom radar text labels
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual const FText& GetRadarLabel() const { return FText::GetEmpty(); }
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual void SetRadarIconOpacity(float Opacity) {}
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual bool IsCloaked() const { return false; }
    UFUNCTION(BlueprintCallable, Category = TrackableInterface)
    virtual bool RegisterOnStart() const { return true; }
 
private:
    FStopTrackingActorSignature StopTrackingEvent;
};