1. Epic GamesDeveloper
  3. AGameplayDebuggerCategoryReplicator

AGameplayDebuggerCategoryReplicator

API > API/Runtime > API/Runtime/GameplayDebugger

Inheritance Hierarchy

References

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

Syntax

class AGameplayDebuggerCategoryReplicator : public AActor

Variables

  Type Name Description
Protected variable uint32: 1 bHasAuthority  
Protected variable uint32: 1 bIsEditorWorldReplicator  
Protected variable bool bIsEnabled  
Protected variable uint32: 1 bIsEnabledLocal  
Protected variable uint32: 1 bIsLocal  
Protected variable uint32: 1 bSendDataPacksUsingRPC  
Protected variable TArray< TSharedRef< FGameplayDebuggerCategory > > Categories Category objects
Protected variable FGameplayDebuggerDebugActor DebugActor  
Protected variable TArray< TSharedRef< FGameplayDebuggerExtension > > Extensions Extension objects
Protected variable friend FGameplayDebuggerNetPack  
Protected variable TObjectPtr< APlayerController > OwnerPC  
Protected variable TObjectPtr< UGameplayDebuggerRenderingComponent > RenderingComp Rendering component needs to attached to some actor, and this is as good as any
Protected variable FGameplayDebuggerNetPack ReplicatedData  
Protected variable TOptional< FVector > ViewDirection  
Protected variable TOptional< FVector > ViewLocation  
Protected variable FGameplayDebuggerVisLogSync VisLogSync  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void Helper function for optionally sending DataPackPackets as RPC's
Public function void

CollectCategoryData ( bool bForce
)

 [AUTH] starts data collection
Public function Const TSharedRef< FGameplayDebuggerCategory >

GetCategory ( int32 CategoryId
)

 Get category object
Public function Const AActor * Get current debug actor
Public function Const int16 Get sync counter, increased with every change of DebugActor
Public function Const FName Get name of debug actor
Public function Const TSharedRef< FGameplayDebuggerExtension >

GetExtension ( int32 ExtensionId
)

 Get category object
Public function Const int32 Get category count
Public function Const int32 Get extension count
Public function Const APlayerController * Get player controller owning this replicator
Public function Const bool

GetViewPoint ( FVector& OutViewLocation,
FVector& OutViewDirection
)

 Get view point information
Public function Const const FGameplayDebuggerVisLogSync &  
Public function Const bool Check if debug actor was selected
Protected function void

Init ()

 Called both from BeginPlay and InitForEditor to setup instance's internal
Public function void  
Public function Const bool

IsCategoryEnabled ( int32 CategoryId
)

 Get category state
Public function Const bool Returns true if this replicator has been created for an editor world
Public function Const bool Get replicator state
Public function Const bool

IsLocal ()

 Returns true if object was created for local player (client / standalone)
Public function Const bool Indicates that a view matrix has been set for culling and picking instead of the associated controller view point
Protected function void

NotifyCategoriesToolState ( bool bIsActive
)

 Send notifies to all categories about current tool state
Protected function void

NotifyExtensionsToolState ( bool bIsActive
)

 Send notifies to all categories about current tool state
Protected function void Notify about changes in known category set
Protected function void Notify about changes in known extensions set
Protected function void

OnReceivedDataPackPacket ( int32 CategoryId,
int32 DataPackId,
const FGameplayDebuggerDataPack& DataPacket
)

 [LOCAL] notify from CategoryData replication
Protected function void  
Public function void [ALL] reset view matrix that should be used for culling and picking to revert on the associated controller view point
Public function void

SendCategoryInputEvent ( int32 CategoryId,
int32 HandlerId
)

 [ALL] send input event to category
Public function void

SendExtensionInputEvent ( int32 ExtensionId,
int32 HandlerId
)

 [ALL] send input event to extension
Protected function void  
Protected function void

ServerSendCategoryInputEvent ( int32 CategoryId,
int32 HandlerId
)

 Helper function for replicating input for category handlers
Protected function void

ServerSendExtensionInputEvent ( int32 ExtensionId,
int32 HandlerId
)

 Helper function for replicating input for extension handlers
Protected function void

ServerSetCategoryEnabled ( int32 CategoryId,
bool bEnable
)

  
Protected function void

ServerSetDebugActor ( AActor* Actor,
bool bSelectInEditor
)

  
Protected function void

ServerSetEnabled ( bool bEnable
)

  
Protected function void

ServerSetViewPoint ( const FVector& InViewLocation,
const FVector& InViewDirection
)

  
Public function void

SetCategoryEnabled ( int32 CategoryId,
bool bEnable
)

 [ALL] set category state
Public function void

SetDebugActor ( AActor* Actor,
bool bSelectInEditor
)

 [ALL] set actor for debugging
Public function void

SetEnabled ( bool bEnable
)

 [ALL] set replicator state
Public function void [AUTH] set new owner
Public function void

SetViewPoint ( const FVector& InViewLocation,
const FVector& InViewDirection
)

 [ALL] set view matrix that should be used for culling and picking instead of the associated controller view point

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual Const UNetConnection * Get the owning connection used for communicating between client/server
Public function Virtual Const bool

IsNetRelevantFor ( const AActor* RealViewer,
const AActor* ViewTarget,
const FVector& SrcLocation
)

 Checks to see if this actor is relevant for a specific network connection
Public function Virtual void

PreReplication ( IRepChangedPropertyTracker& ChangedPropertyTracker
)

 Called on the actor right before replication occurs.
Public function Virtual void

TickActor ( float DeltaTime,
enum ELevelTick TickType,
FActorTickFunction& ThisTickFunction
)

 Dispatches the once-per frame Tick() function for this actor

Overridden from UObject

  Type Name Description
Public function Virtual void Always called immediately after properties are received from the remote.

Constants

Name Description
NotifyDebuggerOwnerChange  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page