FGameplayDebuggerExtension_HUD Class Reference

#include <GameplayDebuggerExtension_HUD.h>

Inheritance diagram for FGameplayDebuggerExtension_HUD:

Public Member Functions
	FGameplayDebuggerExtension_HUD ()
virtual void	OnActivated () override
virtual void	OnDeactivated () override
virtual FString	GetDescription () const override
Public Member Functions inherited from FGameplayDebuggerExtension
virtual	~FGameplayDebuggerExtension ()
virtual GAMEPLAYDEBUGGER_API void	OnGameplayDebuggerActivated () override
virtual GAMEPLAYDEBUGGER_API void	OnGameplayDebuggerDeactivated () override
GAMEPLAYDEBUGGER_API bool	IsLocal () const
Public Member Functions inherited from FGameplayDebuggerAddonBase
virtual	~FGameplayDebuggerAddonBase ()
int32	GetNumInputHandlers () const
FGameplayDebuggerInputHandler &	GetInputHandler (int32 HandlerId)
GAMEPLAYDEBUGGER_API FString	GetInputHandlerDescription (int32 HandlerId) const
GAMEPLAYDEBUGGER_API UWorld *	GetWorldFromReplicator () const
GAMEPLAYDEBUGGER_API UWorld *	GetDataWorld (const APlayerController *OwnerPC, const AActor *DebugActor) const
Public Member Functions inherited from TSharedFromThis< FGameplayDebuggerAddonBase >
TSharedRef< FGameplayDebuggerAddonBase, Mode >	AsShared ()
TSharedRef< FGameplayDebuggerAddonBase const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FGameplayDebuggerAddonBase, Mode >	AsWeak ()
TWeakPtr< FGameplayDebuggerAddonBase const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static TSharedRef< FGameplayDebuggerExtension >	MakeInstance ()
Static Public Member Functions inherited from FGameplayDebuggerAddonBase
static GAMEPLAYDEBUGGER_API bool	IsSimulateInEditor ()

Protected Member Functions
void	ToggleGameHUD ()
void	ToggleDebugMessages ()
void	SetGameHUDEnabled (bool bEnable)
void	SetDebugMessagesEnabled (bool bEnable)
Protected Member Functions inherited from FGameplayDebuggerExtension
GAMEPLAYDEBUGGER_API APlayerController *	GetPlayerController () const
Protected Member Functions inherited from FGameplayDebuggerAddonBase
GAMEPLAYDEBUGGER_API AActor *	FindLocalDebugActor () const
GAMEPLAYDEBUGGER_API AGameplayDebuggerCategoryReplicator *	GetReplicator () const
template<class UserClass >
bool	BindKeyPress (FName KeyName, UserClass *KeyHandlerObject, typename FGameplayDebuggerInputHandler::FHandler::TMethodPtr< UserClass > KeyHandlerFunc, EGameplayDebuggerInputMode InputMode=EGameplayDebuggerInputMode::Local)
template<class UserClass >
bool	BindKeyPress (FName KeyName, FGameplayDebuggerInputModifier KeyModifer, UserClass *KeyHandlerObject, typename FGameplayDebuggerInputHandler::FHandler::TMethodPtr< UserClass > KeyHandlerFunc, EGameplayDebuggerInputMode InputMode=EGameplayDebuggerInputMode::Local)
template<class UserClass >
bool	BindKeyPress (const FGameplayDebuggerInputHandlerConfig &InputConfig, UserClass *KeyHandlerObject, typename FGameplayDebuggerInputHandler::FHandler::TMethodPtr< UserClass > KeyHandlerFunc, EGameplayDebuggerInputMode InputMode=EGameplayDebuggerInputMode::Local)
Protected Member Functions inherited from TSharedFromThis< FGameplayDebuggerAddonBase >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Protected Attributes
uint32	bWantsHUDEnabled: 1
uint32	bIsGameHUDEnabled: 1
uint32	bAreDebugMessagesEnabled: 1
uint32	bPrevDebugMessagesEnabled: 1
uint32	bIsCachedDescriptionValid: 1
int32	HudBindingIdx
int32	MessagesBindingIdx
FString	CachedDescription

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< FGameplayDebuggerAddonBase >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Constructor & Destructor Documentation

FGameplayDebuggerExtension_HUD()

FGameplayDebuggerExtension_HUD::FGameplayDebuggerExtension_HUD

(

)

Member Function Documentation

GetDescription()

FString FGameplayDebuggerExtension_HUD::GetDescription ( ) const

overridevirtual

[LOCAL] description for gameplay debugger's header row, newline character is ignored

Reimplemented from FGameplayDebuggerExtension.

MakeInstance()

TSharedRef< FGameplayDebuggerExtension > FGameplayDebuggerExtension_HUD::MakeInstance ( )

static

OnActivated()

void FGameplayDebuggerExtension_HUD::OnActivated ( )

overridevirtual

[LOCAL] called when added to debugger tool or tool is activated

Reimplemented from FGameplayDebuggerExtension.

OnDeactivated()

void FGameplayDebuggerExtension_HUD::OnDeactivated ( )

overridevirtual

[LOCAL] called when removed from debugger tool or tool is deactivated

Reimplemented from FGameplayDebuggerExtension.

SetDebugMessagesEnabled()

void FGameplayDebuggerExtension_HUD::SetDebugMessagesEnabled ( bool  bEnable )

protected

SetGameHUDEnabled()

void FGameplayDebuggerExtension_HUD::SetGameHUDEnabled ( bool  bEnable )

protected

ToggleDebugMessages()

void FGameplayDebuggerExtension_HUD::ToggleDebugMessages ( )

protected

ToggleGameHUD()

void FGameplayDebuggerExtension_HUD::ToggleGameHUD ( )

protected

Member Data Documentation

bAreDebugMessagesEnabled

uint32 FGameplayDebuggerExtension_HUD::bAreDebugMessagesEnabled

protected

bIsCachedDescriptionValid

uint32 FGameplayDebuggerExtension_HUD::bIsCachedDescriptionValid

mutableprotected

bIsGameHUDEnabled

uint32 FGameplayDebuggerExtension_HUD::bIsGameHUDEnabled

protected

bPrevDebugMessagesEnabled

uint32 FGameplayDebuggerExtension_HUD::bPrevDebugMessagesEnabled

protected

bWantsHUDEnabled

uint32 FGameplayDebuggerExtension_HUD::bWantsHUDEnabled

protected

CachedDescription

FString FGameplayDebuggerExtension_HUD::CachedDescription

mutableprotected

HudBindingIdx

int32 FGameplayDebuggerExtension_HUD::HudBindingIdx

protected

MessagesBindingIdx

int32 FGameplayDebuggerExtension_HUD::MessagesBindingIdx

protected

---

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

• Engine/Source/Runtime/GameplayDebugger/Public/GameplayDebuggerExtension_HUD.h
• Engine/Source/Runtime/GameplayDebugger/Private/GameplayDebuggerExtension_HUD.cpp