//
// FormatDataLibrary: Functions that convert data into FFormatArgumentData
// structs, so that the data can be passed to FText::Format.
//

#pragma once

#include "CoreMinimal.h"
#include "InputCoreTypes.h"
#include "HAL/Platform.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
#include "Kismet/BlueprintFunctionLibrary.h"

#include "FormatDataLibrary.generated.h"

class UlxLuaValues;
struct FlxAnimationStep;
struct FlxMovementComponentState;

/*
 * A library that contains functions that convert data into FFormatArgumentData
 * structs, so that the data can be passed to FTextFormatter::Format.
 * 
 * The FormatLogMessage K2Node scans this library using reflection,
 * looking for functions that have a parameter named "AutoConvertedValue".
 * It uses the type of that parameter to determine which function to
 * call for a given pin type.  Functions without an "AutoConvertedValue"
 * parameter are ignored by the reflection scan.
 *
 */
UCLASS(MinimalAPI)
class UlxFormatDataLibrary : public UBlueprintFunctionLibrary
{
	GENERATED_BODY()

public:
	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataBool(bool AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataByte(uint8 AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataInt(int AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataInt64(int64 AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataFloat(float AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataDouble(double AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataText(FText AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataString(FString AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataName(FName AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataKey(FKey AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataGender(ETextGender AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataObject(UObject *AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataVector(const FVector &AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataVector2D(const FVector2D &AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataRotator(const FRotator &AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataTransform(const FTransform &AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataLuaValues(const UlxLuaValues *AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataAnimationStep(const FlxAnimationStep &AutoConvertedValue, const FString &Name);

	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataMovementComponentState(const FlxMovementComponentState &AutoConvertedValue, const FString &Name);

	// A formatting routine for pins that were never connected.
	//
	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataBlank(const FString &Name);

	// A specialized formatting routine for pins of enum types.
	//
	UFUNCTION(BlueprintPure, meta = (BlueprintInternalUseOnly = "true"), Category = "Luprex|Utility")
	static FFormatArgumentData FormatArgumentDataEnum(uint8 Value, const FString &Name, const UObject *PinSubCategoryObject);
};