GameplayDebuggerExtension.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
// GAMEPLAY DEBUGGER EXTENSION
// 
// Extensions allows creating additional key bindings for gameplay debugger.
// For example, you can use them to add another way of selecting actor to Debug.
//
// Replication is limited only to handling input events and tool state events,
// it's not possible to send variables or RPC calls
//
// It should be compiled and used only when module is included, so every extension class
// needs be placed in #if WITH_GAMEPLAY_DEBUGGER block.
// 
// Extensions needs to be manually registered and unregistered with GameplayDebugger.
// It's best to do it in owning module's Startup / Shutdown, similar to detail view customizations.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "GameplayDebuggerAddonBase.h"
 
class APlayerController;
 
class FGameplayDebuggerExtension : public FGameplayDebuggerAddonBase
{
public:
 
    virtual ~FGameplayDebuggerExtension() {}
    GAMEPLAYDEBUGGER_API virtual void OnGameplayDebuggerActivated() override;
    GAMEPLAYDEBUGGER_API virtual void OnGameplayDebuggerDeactivated() override;
 
    GAMEPLAYDEBUGGER_API virtual FString GetDescription() const;
 
    GAMEPLAYDEBUGGER_API virtual void OnActivated();
 
    GAMEPLAYDEBUGGER_API virtual void OnDeactivated();
 
    GAMEPLAYDEBUGGER_API bool IsLocal() const;
 
protected:
 
    GAMEPLAYDEBUGGER_API APlayerController* GetPlayerController() const;
};