GameplayDebuggerCategory.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
// GAMEPLAY DEBUGGER CATEGORY
// 
// Single category of gameplay debugger tool, responsible for gathering and presenting data.
// Category instances are created on both server and local sides, and can use replication to
// show server's state on client.
// 
// It should be compiled and used only when module is included, so every category class
// needs be placed in #if WITH_GAMEPLAY_DEBUGGER block (or WITH_GAMEPLAY_DEBUGGER_MENU when using WITH_GAMEPLAY_DEBUGGER_CORE).
// 
// 
// Server side category :
// - CollectData() function will be called in category having authority (server / standalone)
// - set CollectDataInterval for adding delay between data collection, default value is 0, meaning: every tick
// - AddTextLine() and AddShape() adds new data to replicate, both arrays are cleared before calling CollectData()
// - SetDataPackReplication() marks struct member variable for replication
// - MarkDataPackDirty() forces data pack replication, sometimes changes can go unnoticed (CRC based)
// 
// Local category :
// - DrawData() function will be called in every tick to present gathered data
// - everything added by AddTextLine() and AddShape() will be shown before calling DrawData()
// - CreateSceneProxy() allows creating custom scene proxies, use with MarkRenderStateDirty()
// - OnDataPackReplicated() notifies about receiving new data, use with MarkRenderStateDirty() if needed
// - BindKeyPress() allows creating custom key bindings active only when category is being displayed
// 
// 
// Categories needs to be manually registered and unregistered with GameplayDebugger.
// It's best to do it in owning module's Startup / Shutdown, similar to detail view customizations.
// Check AIModule.cpp for examples.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameplayDebuggerTypes.h"
#include "GameplayDebuggerAddonBase.h"
 
class AActor;
class APlayerController;
class FDebugRenderSceneProxy;
class UPrimitiveComponent;
struct FDebugDrawDelegateHelper;
 
class FGameplayDebuggerCategory : public FGameplayDebuggerAddonBase
{
public:
 
    GAMEPLAYDEBUGGER_API FGameplayDebuggerCategory();
    GAMEPLAYDEBUGGER_API virtual ~FGameplayDebuggerCategory();
 
    GAMEPLAYDEBUGGER_API virtual void CollectData(APlayerController* OwnerPC, AActor* DebugActor);
 
    GAMEPLAYDEBUGGER_API virtual void DrawData(APlayerController* OwnerPC, FGameplayDebuggerCanvasContext& CanvasContext);
 
    GAMEPLAYDEBUGGER_API virtual FDebugRenderSceneProxy* CreateDebugSceneProxy(const UPrimitiveComponent* InComponent, FDebugDrawDelegateHelper*& OutDelegateHelper);
 
    GAMEPLAYDEBUGGER_API virtual void OnDataPackReplicated(int32 DataPackId);
 
    GAMEPLAYDEBUGGER_API void AddTextLine(const FString& TextLine);
 
    GAMEPLAYDEBUGGER_API void AddShape(const FGameplayDebuggerShape& Shape);
 
    GAMEPLAYDEBUGGER_API void DrawCategory(APlayerController* OwnerPC, FGameplayDebuggerCanvasContext& CanvasContext);
 
    bool ShouldDrawCategory(bool bHasDebugActor) const { return IsCategoryEnabled() && (!bShowOnlyWithDebugActor || bHasDebugActor); }
 
    bool ShouldDrawReplicationStatus() const { return bShowDataPackReplication; }
 
    FName GetCategoryName() const { return CategoryName; }
 
    bool IsCategoryHeaderVisible() const { return bShowCategoryName; }
 
    bool IsCategoryEnabled() const { return bIsEnabled; }
 
    bool IsCategoryLocal() const { return bIsLocal; }
 
    bool IsCategoryAuth() const { return bHasAuthority; }
 
    bool ShouldCollectDataOnClient() const { return bAllowLocalDataCollection; }
 
    int32 GetNumDataPacks() const { return ReplicatedDataPacks.Num(); }
    float GetDataPackProgress(int32 DataPackId) const { return ReplicatedDataPacks.IsValidIndex(DataPackId) ? ReplicatedDataPacks[DataPackId].GetProgress() : 0.0f; }
    bool IsDataPackReplicating(int32 DataPackId) const { return ReplicatedDataPacks.IsValidIndex(DataPackId) && ReplicatedDataPacks[DataPackId].IsInProgress(); }
    FGameplayDebuggerDataPack::FHeader GetDataPackHeaderCopy(int32 DataPackId) const { return ReplicatedDataPacks.IsValidIndex(DataPackId) ? ReplicatedDataPacks[DataPackId].Header : FGameplayDebuggerDataPack::FHeader(); }
 
    // temporary functions for compatibility, will be removed soon
    TArray<FString> GetReplicatedLinesCopy() const { return ReplicatedLines; }
    TArray<FGameplayDebuggerShape> GetReplicatedShapesCopy() const { return ReplicatedShapes; }
 
protected:
    GAMEPLAYDEBUGGER_API bool GetViewPoint(const APlayerController* OwnerPC, FVector& OutViewLocation, FVector& OutViewDirection) const;
 
    static GAMEPLAYDEBUGGER_API bool IsLocationInViewCone(const FVector& ViewLocation, const FVector& ViewDirection, const FVector& TargetLocation);
 
    GAMEPLAYDEBUGGER_API void MarkDataPackDirty(int32 DataPackId);
 
    GAMEPLAYDEBUGGER_API void MarkRenderStateDirty();
 
    GAMEPLAYDEBUGGER_API FString GetSceneProxyViewFlag() const;
 
    template<typename T>
    int32 SetDataPackReplication(T* DataPackAddr, EGameplayDebuggerDataPack Flags = EGameplayDebuggerDataPack::ResetOnTick)
    {
        FGameplayDebuggerDataPack NewDataPack;
        NewDataPack.PackId = ReplicatedDataPacks.Num();
        NewDataPack.Flags = Flags;
        NewDataPack.SerializeDelegate.BindRaw(DataPackAddr, &T::Serialize);
        NewDataPack.ResetDelegate.BindLambda([=] { *DataPackAddr = T(); });
 
        ReplicatedDataPacks.Add(NewDataPack);
        return NewDataPack.PackId;
    }
 
    void ForceImmediateCollect() { LastCollectDataTime = -MAX_dbl; }
 
    GAMEPLAYDEBUGGER_API void ResetReplicatedData();
 
    float CollectDataInterval;
 
    uint32 bShowDataPackReplication : 1;
 
    uint32 bShowUpdateTimer : 1;
 
    uint32 bShowCategoryName : 1;
 
    uint32 bShowOnlyWithDebugActor : 1;
 
    uint32 bAllowLocalDataCollection : 1;
 
private:
 
    friend class FGameplayDebuggerAddonManager;
    friend class AGameplayDebuggerCategoryReplicator;
    friend struct FGameplayDebuggerNetPack;
 
    uint32 bIsLocal : 1;
 
    uint32 bHasAuthority : 1;
 
    uint32 bIsEnabled : 1;
 
    int32 CategoryId;
 
    double LastCollectDataTime;
 
    FName CategoryName;
 
    TArray<FString> ReplicatedLines;
 
    TArray<FGameplayDebuggerShape> ReplicatedShapes;
 
    TArray<FGameplayDebuggerDataPack> ReplicatedDataPacks;
};