| TSharedFromThis
|
Module |
|
Header |
/Engine/Source/Developer/GameplayDebugger/Public/GameplayDebuggerCategory.h |
Include |
#include "GameplayDebuggerCategory.h" |
class FGameplayDebuggerCategory : public FGameplayDebuggerAddonBase
Single category of visual debugger tool
Name | Description | ||
---|---|---|---|
|
uint32: 1 |
bShowCategoryName |
Include category name in drawn messages |
|
uint32: 1 |
bShowDataPackReplication |
Include data pack replication details in drawn messages |
|
uint32: 1 |
bShowOnlyWithDebugActor |
Draw category only when DebugActor is present |
|
uint32: 1 |
bShowUpdateTimer |
Include remaining time to next data collection in drawn messages |
|
float |
CollectDataInterval |
Update interval, 0 = each tick |
Name | Description | |
---|---|---|
|
FGameplayDebuggerCategory() |
Name | Description | |
---|---|---|
|
~FGameplayDebuggerCategory() |
Name | Description | ||
---|---|---|---|
|
AddShape ( |
[AUTH] adds shape to replicated data |
|
|
AddTextLine ( |
[AUTH] adds line of text tagged with {color} to replicated data |
|
|
CollectData ( |
[AUTH] gather data for replication |
|
|
FDebugRender... |
CreateDebugSceneProxy ( |
[LOCAL] creates a scene proxy for more advanced debug rendering |
|
DrawCategory ( |
[LOCAL] draw category |
|
|
DrawData ( |
[LOCAL] draw collected data |
|
|
ForceImmediateCollect() |
[AUTH] force data collection on next update |
|
|
GetCategoryName() |
[ALL] get name of category |
|
|
FGameplayDeb... |
GetDataPackHeaderCopy ( |
|
|
float |
GetDataPackProgress ( |
|
|
GetNumDataPacks() |
||
|
GetReplicatedLinesCopy() |
Temporary functions for compatibility, will be removed soon |
|
|
GetReplicatedShapesCopy() |
||
|
GetSceneProxyViewFlag() |
[LOCAL] preferred view flag for creating scene proxy |
|
|
IsCategoryAuth() |
[ALL] check if category has authority (collects data) |
|
|
IsCategoryEnabled() |
[ALL] check if category is enabled |
|
|
IsCategoryHeaderVisible() |
[ALL] check if category header should be drawn |
|
|
IsCategoryLocal() |
[ALL] check if category is local (present data) |
|
|
IsDataPackReplicating ( |
||
|
MarkDataPackDirty ( |
[AUTH] marks data pack as needing replication |
|
|
MarkRenderStateDirty() |
[LOCAL] requests new scene proxy |
|
|
OnDataPackReplicated ( |
[LOCAL] called after successful replication of entire data pack to client |
|
|
SetDataPackReplication ( |
[ALL] sets up DataPack replication, needs address of property holding data, DataPack's struct must define Serialize(FArchive& Ar) function returns DataPackId |
|
|
ShouldDrawCategory ( |
[LOCAL] check if category should be drawn |
|
|
ShouldDrawReplicationStatus() |
[LOCAL] check if data pack replication status |