Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > GameplayDebugger > AGameplayDebuggerCategoryReplicator

Light Theme

Dark Theme

AGameplayDebuggerCategoryReplicator

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AGameplayDebuggerCategoryReplicator

References

Module	GameplayDebugger
Header	/Engine/Source/Developer/GameplayDebugger/Public/GameplayDebuggerCategoryReplicator.h
Include	#include "GameplayDebuggerCategoryReplicator.h"

Syntax

class AGameplayDebuggerCategoryReplicator : public AActor

Variables

	Name	Description
uint32: 1	bHasAuthority
bool	bIsEnabled
uint32: 1	bIsEnabledLocal
uint32: 1	bIsLocal
TArray< TShared...	Categories	Category objects
FGameplayDebugg...	DebugActor
TArray< TShared...	Extensions	Extension objects
friend	FGameplayDebuggerNetPack
APlayerControll...	OwnerPC
UGameplayDebugg...	RenderingComp	Rendering component needs to attached to some actor, and this is as good as any
FGameplayDebugg...	ReplicatedData
FGameplayDebugg...	VisLogSync

Constructors

	Name	Description
	AGameplayDebuggerCategoryReplicator ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CollectCategoryData ( bool bForce )	[AUTH] starts data collection
TSharedRef< ...	GetCategory ( int32 CategoryId )	Get category object
AActor *	GetDebugActor()	Get current debug actor
int16	GetDebugActorCounter()	Get sync counter, increased with every change of DebugActor
FName	GetDebugActorName()	Get name of debug actor
TSharedRef< ...	GetExtension ( int32 ExtensionId )	Get category object
int32	GetNumCategories()	Get category count
int32	GetNumExtensions()	Get extension count
APlayerContr...	GetReplicationOwner()	Get player controller owning this replicator
const FGamep...	GetVisLogSyncData()
bool	HasDebugActor()	Check if debug actor was selected
bool	IsCategoryEnabled ( int32 CategoryId )	Get category state
bool	IsEnabled()	Get replicator state
bool	IsLocal()	Returns true if object was created for local player (client / standalone)
void	NotifyCategoriesToolState ( bool bIsActive )	Send notifies to all categories about current tool state
void	NotifyExtensionsToolState ( bool bIsActive )	Send notifies to all categories about current tool state
void	OnCategoriesChanged()	Notify about changes in known category set
void	OnExtensionsChanged()	Notify about changes in known extensions set
void	OnReceivedDataPackPacket ( int32 CategoryId, int32 DataPackId, const FGameplayDebuggerDataPack& D... )	[LOCAL] notify from CategoryData replication
void	SendCategoryInputEvent ( int32 CategoryId, int32 HandlerId )	[ALL] send input event to category
void	SendExtensionInputEvent ( int32 ExtensionId, int32 HandlerId )	[ALL] send input event to extension
void	ServerSendCategoryInputEvent ( int32 CategoryId, int32 HandlerId )	Helper function for replicating input for category handlers
void	ServerSendExtensionInputEvent ( int32 ExtensionId, int32 HandlerId )	Helper function for replicating input for extension handlers
void	ServerSetCategoryEnabled ( int32 CategoryId, bool bEnable )
void	ServerSetDebugActor ( AActor* Actor, bool bSelectInEditor )
void	ServerSetEnabled ( bool bEnable )
void	SetCategoryEnabled ( int32 CategoryId, bool bEnable )	[ALL] set category state
void	SetDebugActor ( AActor* Actor, bool bSelectInEditor )	[ALL] set actor for debugging
void	SetEnabled ( bool bEnable )	[ALL] set replicator state
void	SetReplicatorOwner ( APlayerController* InOwnerPC )	[AUTH] set new owner

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
UNetConnecti...	GetNetConnection()	Get the owning connection used for communicating between client/server
bool	IsNetRelevantFor ( const AActor* RealViewer, const AActor* ViewTarget, const FVector& SrcLocation )	Checks to see if this actor is relevant for a specific network connection
void	TickActor ( float DeltaTime, enum ELevelTick TickType, FActorTickFunction& ThisTickFuncti... )	Dispatches the once-per frame Tick() function for this actor

Overridden from UObject

		Name	Description
	void	PostNetReceive()	Always called immediately after properties are received from the remote.

Constants

Name	Description
NotifyDebuggerOwnerChange

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss