Extra Function Library

Overview

The FL_Extra class is a Blueprint Function Library in Unreal Engine, part of the Ino Essentials Plugin. It provides a set of advanced utility functions such as data encoding/decoding, hashing, file I/O, and more. This library is designed to extend the basic functionalities provided by Unreal Engine, making it easier to perform common operations within Blueprints.

Blueprint Function: `Get Map Name`

Description: Returns the name of the current map.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Get Map Name", Keywords = "get map name", HidePin = "WorldContextObject", WorldContext="WorldContextObject", DefaultToSelf = "WorldContextObject"), Category = "Ino|FL|Extra")
static FString GetMapName(UObject* WorldContextObject, bool RemovePrefix);

Parameters:

WorldContextObject: Context object for accessing the world.
RemovePrefix: If true, removes the streaming level prefix from the map name.

Returns:

FString: The name of the map, with or without the streaming prefix depending on the RemovePrefix flag.

Blueprint Function: `Ino Base64 Encode`

Description: Encodes a string to Base64 format.

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Base64 Encode"), Category = "Ino|FL|Extra")
static void Base64Encode(const FString& InString, FString &EncodedString);

Parameters:

InString: The string to encode.
EncodedString: The resulting Base64 encoded string.

Blueprint Function: `Ino Base64 Decode`

Description: Decodes a Base64 encoded string back to its original format.

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Base64 Decode"), Category = "Ino|FL|Extra")
static bool Base64Decode(const FString& EncodedString, FString &DecodedString);

Parameters:

EncodedString: The Base64 encoded string.
DecodedString: The resulting decoded string.

Returns:

true if the decoding was successful.
false if decoding failed.

Blueprint Function: `Ino Base64 Encode Data`

Description: Encodes a byte array (TArray<uint8>) to Base64 format.

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Base64 Encode Data"), Category = "Ino|FL|Extra")
static bool Base64EncodeData(const TArray<uint8>& Data, FString& EncodedData);

Parameters:

Data: The byte array to encode.
EncodedData: The resulting Base64 encoded string.

Returns:

true if the encoding was successful.
false if encoding failed.

Blueprint Function: `Ino Base64 Decode Data`

Description: Decodes a Base64 encoded string back to its original byte array (TArray<uint8>).

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Base64 Decode Data"), Category = "Ino|FL|Extra")
static bool Base64DecodeData(const FString& EncodedData, TArray<uint8>& DecodedData);

Parameters:

EncodedData: The Base64 encoded string.
DecodedData: The resulting decoded byte array.

Returns:

true if the decoding was successful.
false if decoding failed.

Blueprint Function: `Ino Hash MD5`

Description: Generates an MD5 hash from a string.

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Hash MD5"), Category = "Ino|FL|Extra")
static FString HashMD5(const FString& StringToHash);

Parameters:

StringToHash: The string to hash.

Returns:

FString: The resulting MD5 hash.

Blueprint Function: `Ino Hash SHA1`

Description: Generates an SHA1 hash from a string.

Function Signature:

UFUNCTION(BlueprintPure, meta = (DisplayName = "Ino Hash SHA1"), Category = "Ino|FL|Extra")
static FString HashSHA1(const FString& StringToHash);

Parameters:

StringToHash: The string to hash.

Returns:

FString: The resulting SHA1 hash.

Blueprint Function: `Convert TextureRenderTargetCube to TextureCube`

Description: Converts a UTextureRenderTargetCube object to a UTextureCube object.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Convert TextureRenderTargetCube to TextureCube"), Category = "Ino|FL|Extra")
static UTextureCube* TRTC_TC(UTextureRenderTargetCube* InputRenderTargetCube, UObject* InOuter, FString Name = "Test");

Parameters:

InputRenderTargetCube: The input UTextureRenderTargetCube object.
InOuter: The outer object to create the UTextureCube in.
Name: The name for the new texture cube.

Returns:

UTextureCube*: The newly created UTextureCube object.

Blueprint Function: `Reflection Capture Component Set Cube`

Description: Sets a UTextureCube object as the cubemap for a UReflectionCaptureComponent.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Reflection Capture Component Set Cube"), Category = "Ino|FL|Extra")
static bool RCC_SetCube(UReflectionCaptureComponent* ReflectionCapture, UTextureCube* InputCube);

Parameters:

ReflectionCapture: The reflection capture component to set the cubemap for.
InputCube: The cubemap to use.

Returns:

true if the cubemap was successfully set.
false if the operation failed.

Blueprint Function: `Load String From File`

Description: Loads a string from a specified file.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Load String From File"), Category = "Ino|FL|Extra")
static bool LoadStringFromFile(const FString& FilePath, FString& LoadedString);

Parameters:

FilePath: The path to the file to load.
LoadedString: The string loaded from the file.

Returns:

true if the file was successfully loaded.
false if the file could not be found or read.

Blueprint Function: `Save String To File`

Description: Saves a string to a specified file.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Save String To File"), Category = "Ino|FL|Extra")
static bool SaveStringToFile(const FString& InputString, const FString& FilePath, const bool Append);

Parameters:

InputString: The string to save to the file.
FilePath: The path to the file to save.
Append: Whether to append to the file or overwrite it.

Returns:

true if the string was successfully saved.
false if the operation failed.

Blueprint Function: `Get File Size`

Description: Retrieves the size of a specified file.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Get File Size"), Category = "Ino|FL|Extra")
static bool GetFileSize(const FString& FilePath, int64& FileSize);

Parameters:

FilePath: The path to the file.
FileSize: Output parameter to store the file size.

Returns:

true if the file size was successfully retrieved.
false if the file does not exist or the operation failed.

Blueprint Function: `Get Local IP Address`

Description: Retrieves the local IP address of the host machine.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Get local IP address"), Category = "Ino|FL|Extra")
static FString GetLocalIP();

Returns:

FString: The local IP address of the host machine.

Blueprint Function: `Encrypt AES`

Description: Encrypts a string using AES encryption.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Encrypt AES"), Category = "Ino|FL|Extra")
static FString EncryptAES(const FString& PlainText, const FString& Key);

Parameters:

PlainText: The string to encrypt.
Key: The encryption key (must be exactly 32 bytes).

Returns:

FString: The encrypted string (usually in Base64 format).

Blueprint Function: `Decrypt AES`

Description: Decrypts a string encrypted using AES encryption.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "Decrypt AES"), Category = "Ino|FL|Extra")
static FString DecryptAES(const FString& EncryptedText, const FString& Key);

Parameters:

EncryptedText: The encrypted string.
Key: The decryption key (must be exactly 32 bytes).

Returns:

FString: The decrypted string.

Blueprint Function: `Get Timeline Start Time`

Description: Calculates the timeline start time based on the current UTC time, a specified maximum time, and an offset value. This can be useful for synchronizing timelines or animations to real-world time.

Function Signature:

UFUNCTION(BlueprintCallable, meta = (DisplayName = "GetTimelineStartTime"), Category = "Ino|FL|Extra")
static float GetTimelineStartTime(float MaxTime, float offset);

Parameters:

MaxTime: The maximum value for the timeline, which represents the total duration (e.g., 60 for seconds in a minute).
offset: Offset value to adjust the start time.

Returns:

float: The calculated start time, ranging between 0 and MaxTime.

Blueprint Function: `String to Data`

Description: Converts a FString to a byte array (TArray<uint8>), which can be used for binary data storage or serialization.

Function Signature:

UFUNCTION(BlueprintCallable, Category = "Ino|FL|Extra")
static TArray<uint8> StringToData(const FString& InputString);

Parameters:

InputString: The string to convert to a byte array.

Returns:

TArray<uint8>: The byte array representation of the string.

Blueprint Function: `Data to String`

Description: Converts a byte array (TArray<uint8>) back to a FString. This is useful for deserializing binary data into readable strings.

Function Signature:

UFUNCTION(BlueprintCallable, Category = "Ino|FL|Extra")
static FString DataToString(const TArray<uint8>& InputData);

Parameters:

InputData: The byte array to convert back to a string.

Returns:

FString: The resulting string from the byte array.

Blueprint Function: `Compress Data With Oodle`

Description: Compresses the input data using the Oodle compression library. This can reduce the size of data for storage or transmission.

Function Signature:

UFUNCTION(BlueprintCallable, Category = "Ino|FL|Extra")
static bool CompressDataWithOodle(
    const TArray<uint8>& InUncompressedData,
    EInoCompressor InCompressor,
    EInoCompressionLevel InCompressionLevel,
    int32& OutUnCompressedSize,
    TArray<uint8>& OutCompressedData
);

Parameters:

InUncompressedData: The data to be compressed.
InCompressor: The Oodle compressor type to use.
InCompressionLevel: The compression level to apply (e.g., high, medium, low).
OutUnCompressedSize: Output parameter to store the original size of the uncompressed data.
OutCompressedData: Output parameter to store the compressed data.

Returns:

true if compression was successful.
false if the compression failed.

Blueprint Function: `Decompress Data With Oodle`

Description: Decompresses data that was compressed using the Oodle compression library.

Function Signature:

UFUNCTION(BlueprintCallable, Category = "Ino|FL|Extra")
static bool DecompressDataWithOodle(const TArray<uint8>& InCompressedData, const int32& InUnCompressedSize, TArray<uint8>& OutUncompressedData);

Parameters:

InCompressedData: The compressed data to decompress.
InUnCompressedSize: The expected size of the uncompressed data.
OutUncompressedData: Output parameter to store the decompressed data.

Returns:

true if decompression was successful.
false if the decompression failed.

PreviousBase Function Library NextIno UI Subsystem

Last updated 11 months ago

Blueprint Function: Get Map Name

Blueprint Function: Ino Base64 Encode

Blueprint Function: Ino Base64 Decode

Blueprint Function: Ino Base64 Encode Data

Blueprint Function: Ino Base64 Decode Data

Blueprint Function: Ino Hash MD5

Blueprint Function: Ino Hash SHA1

Blueprint Function: Convert TextureRenderTargetCube to TextureCube

Blueprint Function: Reflection Capture Component Set Cube

Blueprint Function: Load String From File

Blueprint Function: Save String To File

Blueprint Function: Get File Size

Blueprint Function: Get Local IP Address

Blueprint Function: Encrypt AES

Blueprint Function: Decrypt AES

Blueprint Function: Get Timeline Start Time

Blueprint Function: String to Data

Blueprint Function: Data to String

Blueprint Function: Compress Data With Oodle

Blueprint Function: Decompress Data With Oodle

Blueprint Function: `Get Map Name`

Blueprint Function: `Ino Base64 Encode`

Blueprint Function: `Ino Base64 Decode`

Blueprint Function: `Ino Base64 Encode Data`

Blueprint Function: `Ino Base64 Decode Data`

Blueprint Function: `Ino Hash MD5`

Blueprint Function: `Ino Hash SHA1`

Blueprint Function: `Convert TextureRenderTargetCube to TextureCube`

Blueprint Function: `Reflection Capture Component Set Cube`

Blueprint Function: `Load String From File`

Blueprint Function: `Save String To File`

Blueprint Function: `Get File Size`

Blueprint Function: `Get Local IP Address`

Blueprint Function: `Encrypt AES`

Blueprint Function: `Decrypt AES`

Blueprint Function: `Get Timeline Start Time`

Blueprint Function: `String to Data`

Blueprint Function: `Data to String`

Blueprint Function: `Compress Data With Oodle`

Blueprint Function: `Decompress Data With Oodle`