BaseHelpersBPLib.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameplayTagContainer.h"
#include "Data/BaseData.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Kismet/KismetSystemLibrary.h"
#include "Logging/LogCategory.h"
#include "BaseHelpersBPLib.generated.h"
 
class UInputAction;
 
UCLASS()
class BASEHELPERS_API UBaseHelpersBPLib : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    static UWorld* FindPlayInEditorAuthorityWorld();
    static APlayerController* FindPlayInEditorAuthorityPlayerController(const APlayerController* ClientController);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers", meta=(WorldContext="WorldContextObject"))
    static void PrintToLog(const UObject* WorldContextObject, const FString& Message, const bool bWarning = false, const bool bError = false);
    static void PrintToLogWithCategory(const UObject* WorldContextObject, const FLogCategoryBase& Category, const FString& Message, const bool bWarning = false, const bool bError = false);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static FCharacterBaseSkills RandomCharacterSkills(const int32 Min, const int32 Max);
 
    static int32 GetPlayerTeamID(AController* Controller);
    static int32 GetPlayerTeamID(APlayerState* PlayerState);
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static int32 GetPlayerTeamIDFromController(AController* Controller);
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static int32 GetPlayerTeamIDFromState(APlayerState* PlayerState);
 
    static UClass* GetDefaultBPClass(const FString& Location);
    static TSubclassOf<AActor> GetDefaultActorBPClass(const FString& Location);
    static TSubclassOf<UUserWidget> GetDefaultWidgetBPClass(const FString& Location);
    static UDataTable* GetDefaultDataTable(const FString& Location);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static void PrintVirtualBoneInfo(USkeletalMeshComponent* SkeletalMeshComponent);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static void ToggleWidgetVisibility(UUserWidget* Widget, const bool bForceSetVisible = false,const bool bForceSetCollapsed = false);
    
    //@TODO Widget to focus
    //- Widget To focus not currently working..
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static void ToggleInputMode(APlayerController* InController, const bool bForceGameOnly = false, const bool bForceUI = false, class UUserWidget* WidgetToFocus = nullptr);
    
    //@TODO Using Controller, Keyboard, Mouse, etc
    // UFUNCTION(BlueprintPure, Category = "Base Helpers")
    // static void GetPlayerInputType(APlayerController* InController);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static ESoundSource SoundSourceFromName(const FName& SoundName);
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static FName SoundNameFromSource(const ESoundSource SoundSource);
 
    UFUNCTION(BlueprintCallable, Category="Base Helpers|Gameplay Tags")
    static FString GetGameplayTagName(const FGameplayTag& GameplayTag);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static FString DescribeColorHelper(const FColor& Color)
    {
        const int32 MaxColors = GColorList.GetColorsNum();
        for (int32 Idx = 0; Idx < MaxColors; Idx++)
        {
            if (Color == GColorList.GetFColorByIndex(Idx))
            {
                return GColorList.GetColorNameByIndex(Idx);
            }
        }
 
        return FString(TEXT("color"));
    }
 
    UFUNCTION(BlueprintCallable, Category = "Character")
    static TArray<FGameplayTag> GetAllTagsOfCategory(const FName& Category);
 
    // UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Base Helpers", meta=(WorldContext="WorldContextObject"))
    // static FString GetAssignedKeyName(const UObject* WorldContextObject, const UInputAction* InputAction, const int32 Num = 0);
 
    UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Base Helpers")
    static FString GetEnumValue(const FString& BaseString);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static bool GetInteraction(FInteractionType& InteractionType, const FInteractionData& InteractionData, const int32 Value);
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static bool GetInteractionFromType(FInteractionType& InteractionType, const FInteractionData& InteractionData, const EInteractionType Interaction);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers", meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="ActorsToIgnore"))
    static bool LineTraceByChannel(const UObject* WorldContextObject, FHitResult& Hit, const FVector& Start, const FVector& End,
        const ETraceTypeQuery TraceChannel, const TArray<AActor*>& ActorsToIgnore, const bool bIgnoreSelf, const bool bReturnPhysicalMaterial = false, const bool bTraceComplex = false, const bool bDebug = false,
         const FLinearColor TraceColor = FLinearColor::Red, const float DrawTime = 2.0f);
 
    //- Gets Trace Start based on Camera Manager Location //
    UFUNCTION(BlueprintPure, Category = "Character")
    static FVector GetTraceStartLocation(const APlayerController* InController);
    //- Gets Trace Rotation based on Camera Manager Rotation //
    UFUNCTION(BlueprintPure, Category = "Character")
    static FRotator GetTraceStartRotation(const APlayerController* InController);
    //- Gets Trace Start based on NPC Eyes Location //
    UFUNCTION(BlueprintPure, Category = "Character")
    static FVector GetTraceStartEyeLocation(const APawn* Pawn);
    //- Gets Trace Rotation based on NPC Eyes Rotation //
    UFUNCTION(BlueprintPure, Category = "Character")
    static FRotator GetTraceStartEyeRotation(const APawn* Pawn);
 
    UFUNCTION(BlueprintPure, Category = "Math")
    static float CalculateRatio(const int32 Kills, const int32 Deaths);
 
 
    //- Gets Trace end based on Camera Manager //
    UFUNCTION(BlueprintPure, Category = "Character")
    static FVector GetTraceEndLocation(const APlayerController* InController, const float InLength);
 
    UFUNCTION(BlueprintPure, Category = "Character")
    static FHitResult SimpleLineTrace(const APlayerController* InController, const float InLength, const bool bDebug);
 
    // UFUNCTION(BlueprintPure, Category = "Character")
    // static bool GetIsWidgetVisible(class UUserWidget* Widget);
    // UFUNCTION(BlueprintPure, Category = "Character")
    // static bool GetIsWidgetVisibleByVisibility(ESlateVisibility Visibility);
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    static UTexture2D* TextureFromWidget(UUserWidget*const Widget, const FVector2D &DrawSize);
    
 
    //-     Damage Types        //
    UFUNCTION(BlueprintPure, Category = "Damage Types")
    static EDamageType DamageTypeToEnum(const UDamageType* DamageType);  
    UFUNCTION(BlueprintPure, Category = "Damage Types")
    static bool IsDamageTypeNonLethal(const UDamageType* DamageType);  
 
    UFUNCTION(BlueprintPure, Category = "Debug")
    static EDrawDebugTrace::Type GetDrawDebugType(const bool bDebuggingMode);
 
    
};