ALSDebugComponent.h

Go to the documentation of this file.

// Copyright:       Copyright (C) 2022 Doğa Can Yanıkoğlu
// Source Code:     https://github.com/dyanikoglu/ALS-Community
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "Kismet/KismetSystemLibrary.h"
#include "Components/ActorComponent.h"
#include "ALSDebugComponent.generated.h"
 
class AALSBaseCharacter;
class USkeletalMesh;
 
UCLASS(Blueprintable, BlueprintType)
class ALSV4_CPP_API UALSDebugComponent : public UActorComponent
{
    GENERATED_BODY()
 
public:
    UALSDebugComponent();
 
    virtual void BeginPlay() override;
 
    UFUNCTION(BlueprintImplementableEvent, BlueprintCallable, Category = "ALS|Debug")
    void OnPlayerControllerInitialized(APlayerController* Controller);
 
    virtual void TickComponent(float DeltaTime, ELevelTick TickType,
                               FActorComponentTickFunction* ThisTickFunction) override;
 
    virtual void OnComponentDestroyed(bool bDestroyingHierarchy) override;
 
    UFUNCTION(BlueprintImplementableEvent, Category = "ALS|Debug")
    void UpdateColoringSystem();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "ALS|Debug")
    void DrawDebugSpheres();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "ALS|Debug")
    void SetResetColors();
 
    UFUNCTION(BlueprintImplementableEvent, Category = "ALS|Debug")
    void SetDynamicMaterials();
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleGlobalTimeDilationLocal(float TimeDilation);
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleSlomo();
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleHud() { bShowHud = !bShowHud; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleDebugView();
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "ALS|Debug")
    void OpenOverlayMenu(bool bValue);
 
    UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "ALS|Debug")
    void OverlayMenuCycle(bool bValue);
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleDebugMesh();
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleTraces() { bShowTraces = !bShowTraces; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleDebugShapes() { bShowDebugShapes = !bShowDebugShapes; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleLayerColors() { bShowLayerColors = !bShowLayerColors; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void ToggleCharacterInfo() { bShowCharacterInfo = !bShowCharacterInfo; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    bool GetDebugView() { return bDebugView; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    bool GetShowTraces() { return bShowTraces; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    bool GetShowDebugShapes() { return bShowDebugShapes; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    bool GetShowLayerColors() { return bShowLayerColors; }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Debug")
    void FocusedDebugCharacterCycle(bool bValue);
 
    // utility functions to draw trace debug shapes,
    // which are derived from Engine/Private/KismetTraceUtils.h.
    // Sadly the functions are private, which was the reason
    // why there reimplemented here.
    static void DrawDebugLineTraceSingle(const UWorld* World,
                                         const FVector& Start,
                                         const FVector& End,
                                         EDrawDebugTrace::Type DrawDebugType,
                                         bool bHit,
                                         const FHitResult& OutHit,
                                         FLinearColor TraceColor,
                                         FLinearColor TraceHitColor,
                                         float DrawTime);
 
    static void DrawDebugCapsuleTraceSingle(const UWorld* World,
                                            const FVector& Start,
                                            const FVector& End,
                                            const FCollisionShape& CollisionShape,
                                            EDrawDebugTrace::Type DrawDebugType,
                                            bool bHit,
                                            const FHitResult& OutHit,
                                            FLinearColor TraceColor,
                                            FLinearColor TraceHitColor,
                                            float DrawTime);
 
    static void DrawDebugSphereTraceSingle(const UWorld* World,
                                           const FVector& Start,
                                           const FVector& End,
                                           const FCollisionShape& CollisionShape,
                                           EDrawDebugTrace::Type DrawDebugType,
                                           bool bHit,
                                           const FHitResult& OutHit,
                                           FLinearColor TraceColor,
                                           FLinearColor TraceHitColor,
                                           float DrawTime);
 
protected:
    void DetectDebuggableCharactersInWorld();
 
public:
    UPROPERTY(BlueprintReadOnly, Category = "ALS|Debug")
    TObjectPtr<AALSBaseCharacter> OwnerCharacter;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "ALS|Debug")
    bool bSlomo = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "ALS|Debug")
    bool bShowHud = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "ALS|Debug")
    bool bShowCharacterInfo = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "ALS|Debug")
    TObjectPtr<USkeletalMesh> DebugSkeletalMesh = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "ALS|Debug")
    TArray<TObjectPtr<AALSBaseCharacter>> AvailableDebugCharacters;
 
    UPROPERTY(BlueprintReadOnly, Category = "ALS|Debug")
    TObjectPtr<AALSBaseCharacter> DebugFocusCharacter = nullptr;
private:
    static bool bDebugView;
 
    static bool bShowTraces;
 
    static bool bShowDebugShapes;
 
    static bool bShowLayerColors;
 
    bool bNeedsColorReset = false;
 
    bool bDebugMeshVisible = false;
 
    UPROPERTY()
    TObjectPtr<USkeletalMesh> DefaultSkeletalMesh = nullptr;
 
    int32 FocusedDebugCharacterIndex = INDEX_NONE;
};