OwnedInterface.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 "GameFramework/PlayerState.h"
#include "UObject/Interface.h"
#include "Kismet/GameplayStatics.h"
#include "OwnedInterface.generated.h"
 
/* THIS INTERFACE SHOULD NEVER BE A BLUEPRINT TYPE (templated getting will become unusable!) */
UINTERFACE(meta=(CannotImplementInterfaceInBlueprint))
class PROJECTX_API UOwnedInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class PROJECTX_API IOwnedInterface
{
    GENERATED_IINTERFACE_BODY()
 
public:
    template <class T>
    T* GetOwnedPlayerState() const
    {
        return Cast<T>(GetOwnedPlayerState());
    }
 
    UFUNCTION(BlueprintCallable, Category = PlayerOwnedInterface)
    virtual APlayerState* GetOwnedPlayerState() const;
 
    template <class T>
    T* GetOwningController() const
    {
        return Cast<T>(GetOwningController());
    }
 
    /* You only need to override this if you don't want this to return the owner of result of GetPlayerState() */
    UFUNCTION(BlueprintCallable, Category = PlayerOwnedInterface)
    virtual AController* GetOwningController() const;
 
    UFUNCTION()
    virtual void OnOwnerLeave() {}
    UFUNCTION()
    virtual void OnOwnerDied() {}
};
 
UCLASS()
class PROJECTX_API UOwnedInterfaceHelper : public UObject
{
    GENERATED_BODY()
 
public:
    /* Returns all actors in the world that implement IPlayerOwnedInterface. */
    static void GetPlayerOwnedActorList(const UObject* WorldContextObject, TArray<IOwnedInterface*>& ActorList);
 
    /* Returns a PlayerState given an actor that implements the IPlayerOwnedInterface. */
    UFUNCTION(BlueprintPure, Category = PlayerOwnedInterface)
    static APlayerState* GetPlayerStateFromActor(const AActor* Actor);
};