UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FGameplayDebuggerModule Class Reference

#include <GameplayDebuggerModule.h>

+ Inheritance diagram for FGameplayDebuggerModule:

Public Member Functions

virtual void StartupModule () override
 
virtual void ShutdownModule () override
 
virtual void RegisterCategory (FName CategoryName, IGameplayDebugger::FOnGetCategory MakeInstanceDelegate, EGameplayDebuggerCategoryState CategoryState, int32 SlotIdx) override
 
virtual void UnregisterCategory (FName CategoryName) override
 
virtual void NotifyCategoriesChanged () override
 
virtual void RegisterExtension (FName ExtensionName, IGameplayDebugger::FOnGetExtension MakeInstanceDelegate) override
 
virtual void UnregisterExtension (FName ExtensionName) override
 
virtual void NotifyExtensionsChanged () override
 
AGameplayDebuggerPlayerManagerGetPlayerManager (UWorld *World)
 
void OnWorldInitialized (UWorld *World, const UWorld::InitializationValues IVS)
 
- Public Member Functions inherited from IGameplayDebugger
 DECLARE_DELEGATE_RetVal (TSharedRef< class FGameplayDebuggerCategory >, FOnGetCategory)
 
 DECLARE_DELEGATE_RetVal (TSharedRef< class FGameplayDebuggerExtension >, FOnGetExtension)
 
virtual void RegisterCategory (FName CategoryName, FOnGetCategory MakeInstanceDelegate, EGameplayDebuggerCategoryState CategoryState=EGameplayDebuggerCategoryState::Disabled, int32 SlotIdx=INDEX_NONE)=0
 
virtual void RegisterExtension (FName ExtensionName, FOnGetExtension MakeInstanceDelegate)=0
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Public Attributes

FGameplayDebuggerAddonManager AddonManager
 
TMap< TWeakObjectPtr< UWorld >, TWeakObjectPtr< AGameplayDebuggerPlayerManager > > PlayerManagers
 

Static Public Attributes

static GAMEPLAYDEBUGGER_API FOnLocalControllerInitialized OnLocalControllerInitialized
 
static GAMEPLAYDEBUGGER_API FOnLocalControllerUninitialized OnLocalControllerUninitialized
 

Additional Inherited Members

- Static Public Member Functions inherited from IGameplayDebugger
static IGameplayDebuggerGet ()
 
static bool IsAvailable ()
 

Member Function Documentation

◆ GetPlayerManager()

AGameplayDebuggerPlayerManager & FGameplayDebuggerModule::GetPlayerManager ( UWorld World)

◆ NotifyCategoriesChanged()

void FGameplayDebuggerModule::NotifyCategoriesChanged ( )
overridevirtual

Implements IGameplayDebugger.

◆ NotifyExtensionsChanged()

void FGameplayDebuggerModule::NotifyExtensionsChanged ( )
overridevirtual

Implements IGameplayDebugger.

◆ OnWorldInitialized()

void FGameplayDebuggerModule::OnWorldInitialized ( UWorld World,
const UWorld::InitializationValues  IVS 
)

◆ RegisterCategory()

void FGameplayDebuggerModule::RegisterCategory ( FName  CategoryName,
IGameplayDebugger::FOnGetCategory  MakeInstanceDelegate,
EGameplayDebuggerCategoryState  CategoryState,
int32  SlotIdx 
)
overridevirtual

◆ RegisterExtension()

void FGameplayDebuggerModule::RegisterExtension ( FName  ExtensionName,
IGameplayDebugger::FOnGetExtension  MakeInstanceDelegate 
)
overridevirtual

◆ ShutdownModule()

void FGameplayDebuggerModule::ShutdownModule ( )
overridevirtual

Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finish StartupModule(). This means that, as long as a module references dependent modules in it's StartupModule(), it can safely reference those dependencies in ShutdownModule() as well.

Reimplemented from IModuleInterface.

◆ StartupModule()

void FGameplayDebuggerModule::StartupModule ( )
overridevirtual

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule. ie:

FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

Reimplemented from IModuleInterface.

◆ UnregisterCategory()

void FGameplayDebuggerModule::UnregisterCategory ( FName  CategoryName)
overridevirtual

Implements IGameplayDebugger.

◆ UnregisterExtension()

void FGameplayDebuggerModule::UnregisterExtension ( FName  ExtensionName)
overridevirtual

Implements IGameplayDebugger.

Member Data Documentation

◆ AddonManager

FGameplayDebuggerAddonManager FGameplayDebuggerModule::AddonManager

◆ OnLocalControllerInitialized

FOnLocalControllerInitialized FGameplayDebuggerModule::OnLocalControllerInitialized
static

◆ OnLocalControllerUninitialized

FOnLocalControllerUninitialized FGameplayDebuggerModule::OnLocalControllerUninitialized
static

◆ PlayerManagers

TMap<TWeakObjectPtr<UWorld>, TWeakObjectPtr<AGameplayDebuggerPlayerManager> > FGameplayDebuggerModule::PlayerManagers

The documentation for this class was generated from the following files: