FGameplayDebuggerExtension Class Reference

#include <GameplayDebuggerExtension.h>

Inheritance diagram for FGameplayDebuggerExtension:

Public Member Functions
virtual	~FGameplayDebuggerExtension ()
virtual GAMEPLAYDEBUGGER_API void	OnGameplayDebuggerActivated () override
virtual GAMEPLAYDEBUGGER_API void	OnGameplayDebuggerDeactivated () override
virtual GAMEPLAYDEBUGGER_API FString	GetDescription () const
virtual GAMEPLAYDEBUGGER_API void	OnActivated ()
virtual GAMEPLAYDEBUGGER_API void	OnDeactivated ()
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

Protected Member Functions
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 ()

Additional Inherited Members
Static Public Member Functions inherited from FGameplayDebuggerAddonBase
static GAMEPLAYDEBUGGER_API bool	IsSimulateInEditor ()
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()

virtual FGameplayDebuggerExtension::~FGameplayDebuggerExtension ( )

inlinevirtual

Member Function Documentation

GetDescription()

FString FGameplayDebuggerExtension::GetDescription ( ) const

virtual

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

Reimplemented in FGameplayDebuggerExtension_HUD, and FGameplayDebuggerExtension_Spectator.

GetPlayerController()

APlayerController * FGameplayDebuggerExtension::GetPlayerController ( ) const

protected

get player controller owning gameplay debugger tool

IsLocal()

bool FGameplayDebuggerExtension::IsLocal

(

)

const

check if extension is created for local player

OnActivated()

void FGameplayDebuggerExtension::OnActivated ( )

virtual

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

Reimplemented in FGameplayDebuggerExtension_HUD.

OnDeactivated()

void FGameplayDebuggerExtension::OnDeactivated ( )

virtual

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

Reimplemented in FGameplayDebuggerExtension_HUD, and FGameplayDebuggerExtension_Spectator.

OnGameplayDebuggerActivated()

void FGameplayDebuggerExtension::OnGameplayDebuggerActivated ( )

overridevirtual

[ALL] called when gameplay debugger is activated

Reimplemented from FGameplayDebuggerAddonBase.

OnGameplayDebuggerDeactivated()

void FGameplayDebuggerExtension::OnGameplayDebuggerDeactivated ( )

overridevirtual

[ALL] called when gameplay debugger is deactivated

Reimplemented from FGameplayDebuggerAddonBase.

---

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

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