UnrealEngineUWP/Engine/Source/Developer/GameplayDebugger/Public/GameplayDebugger.h

// Copyright 1998-2016 Epic Games, Inc. All Rights Reserved.

// GAMEPLAY DEBUGGER
// 
// This tool allows easy on screen debugging of gameplay data, supporting client-server replication.
// Data is organized into named categories, which can be toggled during debugging.
// 
// To enable it, press Apostrophe key (UGameplayDebuggerConfig::ActivationKey)
//
// Category class:
// - derives from FGameplayDebuggerCategory
// - implements at least CollectData() and DrawData() functions
// - requires WITH_GAMEPLAY_DEBUGGER define to compile (doesn't exist in shipping builds by default)
// - needs to be registered and unregistered manually by owning module
// - automatically replicate data added with FGameplayDebuggerCategory::AddTextLine, FGameplayDebuggerCategory::AddShape
// - automatically replicate data structs initialized with FGameplayDebuggerCategory::SetDataPackReplication
// - can define own input bindings (e.g. subcategories, etc)
//
// Extension class:
// - derives from FGameplayDebuggerExtension
// - needs to be registered and unregistered manually by owning module
// - can define own input bindings
// - basically it's a stateless, not replicated, not drawn category, ideal for making e.g. different actor selection mechanic
//
// 
// Check FGameplayDebuggerCategory_BehaviorTree for implementation example.
// Check AIModule/Private/AIModule.cpp for registration example.
//
//
// Remember to define WITH_GAMEPLAY_DEBUGGER=1 when adding module to your project's Build.cs!
// 
// if (UEBuildConfiguration.bBuildDeveloperTools &&
//     Target.Configuration != UnrealTargetConfiguration.Shipping &&
//     Target.Configuration != UnrealTargetConfiguration.Test)
// {
//     PrivateDependencyModuleNames.Add("GameplayDebugger");
//     Definitions.Add("WITH_GAMEPLAY_DEBUGGER=1");
// }
//
//
// -----------------------------------------------------------------------------------------------------
// UPGRADE NOTES:
// 
// GameplayDebuggingComponent and GameplayDebuggingHUDComponent classes are no longer supported.
// Instead of adding new project specific module, now you can create FGameplayDebuggerCategory classes
// within project module. 
// 
// If you need to use old GameplayDebugger implementation, please set bEnableDeprecatedDebugger flag in GameplayDebugger.Build.cs
// 

#pragma once

#include "ModuleManager.h"

enum class EGameplayDebuggerCategoryState : uint8
{
	EnabledInGameAndSimulate,
	EnabledInGame,
	EnabledInSimulate,
	Disabled,
};

class IGameplayDebugger : public IModuleInterface
{

public:
	DECLARE_DELEGATE_RetVal(TSharedRef<class FGameplayDebuggerCategory>, FOnGetCategory);
	DECLARE_DELEGATE_RetVal(TSharedRef<class FGameplayDebuggerExtension>, FOnGetExtension);

	/**
	 * Singleton-like access to this module's interface.  This is just for convenience!
	 * Beware of calling this during the shutdown phase, though.  Your module might have been unloaded already.
	 *
	 * @return Returns singleton instance, loading the module on demand if needed
	 */
	static inline IGameplayDebugger& Get()
	{
		return FModuleManager::LoadModuleChecked< IGameplayDebugger >("GameplayDebugger");
	}

	/**
	 * Checks to see if this module is loaded and ready.  It is only valid to call Get() if IsAvailable() returns true.
	 *
	 * @return True if the module is loaded and ready to use
	 */
	static inline bool IsAvailable()
	{
		return FModuleManager::Get().IsModuleLoaded("GameplayDebugger");
	}

	virtual void RegisterCategory(FName CategoryName, FOnGetCategory MakeInstanceDelegate, EGameplayDebuggerCategoryState CategoryState = EGameplayDebuggerCategoryState::Disabled, int32 SlotIdx = INDEX_NONE) = 0;
	virtual void UnregisterCategory(FName CategoryName) = 0;
	virtual void NotifyCategoriesChanged() = 0;
	virtual void RegisterExtension(FName ExtensionName, FOnGetExtension MakeInstanceDelegate) = 0;
	virtual void UnregisterExtension(FName ExtensionName) = 0;
	virtual void NotifyExtensionsChanged() = 0;

#if ENABLE_OLD_GAMEPLAY_DEBUGGER
	virtual bool CreateGameplayDebuggerForPlayerController(APlayerController* PlayerController) = 0;
	virtual bool IsGameplayDebuggerActiveForPlayerController(APlayerController* PlayerController) = 0;
#else
	DEPRECATED_FORGAME(4.13, "This function is now deprecated, please check GameplayDebugger.h for details.")
	virtual bool CreateGameplayDebuggerForPlayerController(APlayerController* PlayerController) { return false; }
	
	DEPRECATED_FORGAME(4.13, "This function is now deprecated, please check GameplayDebugger.h for details.")
	virtual bool IsGameplayDebuggerActiveForPlayerController(APlayerController* PlayerController) { return false; }
#endif
};

#if ENABLE_OLD_GAMEPLAY_DEBUGGER
class GameplayDebugger : public IGameplayDebugger
{
public:
	static inline GameplayDebugger& Get() { return FModuleManager::LoadModuleChecked< GameplayDebugger >("GameplayDebugger"); }
	virtual void UseNewGameplayDebugger() = 0;
};
#else
class DEPRECATED_FORGAME(4.13, "This module interface is now deprecated, please check GameplayDebugger.h for details.") GameplayDebugger : public IGameplayDebugger
{
public:
	static inline GameplayDebugger& Get() { return FModuleManager::LoadModuleChecked< GameplayDebugger >("GameplayDebugger"); }
	virtual void UseNewGameplayDebugger() {}
};
#endif