EGameplayDebuggerCategoryState

GAMEPLAY DEBUGGER

Windows
MacOS
Linux

Syntax

enum EGameplayDebuggerCategoryState
{
    EnabledInGameAndSimulate,
    EnabledInGame,
    EnabledInSimulate,
    Disabled,
    Hidden,
}

Values

Name

Description

EnabledInGameAndSimulate

EnabledInGame

EnabledInSimulate

Disabled

Hidden

Remarks

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](API\Developer\GameplayDebugger\UGameplayDebuggerConfig\ActivationKey))

Category class:

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! Check AIModule/AIModule.Build.cs for more details.

References

Module

GameplayDebugger

Header

Developer/GameplayDebugger/Public/GameplayDebugger.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback