UMapUtilities Class Reference

#include <MapUtilities.h>

Inheritance diagram for UMapUtilities:

Collaboration diagram for UMapUtilities:

Static Public Member Functions
static TArray< FString >	GetAllMapNames (bool onlyAgrarsenseMapFolder=true, bool logResults=false)
static TArray< FString >	GetAllMapPaths (bool onlyAgrarsenseMapFolder=true, bool logResults=false)
static TArray< FAssetData >	GetAllMapAssetDatas (bool onlyAgrarsenseMapFolder=true)

Static Private Member Functions
static TArray< FAssetData >	GetAssetData (bool onlyAgrarsenseMapFolder)

Detailed Description

A class for map related utilies.

Definition at line 18 of file MapUtilities.h.

Member Function Documentation

GetAllMapAssetDatas()

TArray< FAssetData > UMapUtilities::GetAllMapAssetDatas ( bool  onlyAgrarsenseMapFolder = true )

static

Get all maps with its full FAssetData information in the whole project or just Agrarsense map folder.

Parameters

onlyAgrarsenseMapFolder

Should we only look up path where all Agrarsense maps are or the entire Unreal project

Returns

array of maps FAssetData which contains map name, path etc.

Definition at line 61 of file MapUtilities.cpp.

{
    TArray<FAssetData> AssetDatas = GetAssetData(onlyAgrarsenseMapFolder);
 
    return AssetDatas;
}

References GetAssetData().

GetAllMapNames()

TArray< FString > UMapUtilities::GetAllMapNames ( bool  onlyAgrarsenseMapFolder = true, bool  logResults = false  )

static

Get all map names in the whole project or just Agrarsense map folder.

Parameters

onlyAgrarsenseMapFolder	Should we only look up path where all Agrarsense maps are or the entire Unreal project
logResults	should results be logged to console

Returns

array of string

Definition at line 9 of file MapUtilities.cpp.

{
    TArray<FAssetData> AssetDatas = GetAssetData(onlyAgrarsenseMapFolder);
 
    TArray<FString> mapNames = TArray<FString>();
    for (int32 i = 0; i < AssetDatas.Num(); ++i)
    {
        FAssetData& mapAssetData = AssetDatas[i];
        auto name = mapAssetData.AssetName.ToString();
        mapNames.Add(name);
    }
 
#if WITH_EDITOR
    if (logResults)
    {
        UE_LOG(LogTemp, Warning, TEXT("Found %d maps. Map names:"), AssetDatas.Num());
        for (int i = 0; i < mapNames.Num(); i++)
        {
            UE_LOG(LogTemp, Warning, TEXT("%s"), *mapNames[i]);
        }
    }
#endif
 
    return mapNames;
}

References GetAssetData().

GetAllMapPaths()

TArray< FString > UMapUtilities::GetAllMapPaths ( bool  onlyAgrarsenseMapFolder = true, bool  logResults = false  )

static

Get all map paths in the whole project or just Agrarsense map folder.

Parameters

onlyAgrarsenseMapFolder	Should we only look up path where all Agrarsense maps are or the entire Unreal project
logResults	should results be logged to console

Returns

array of string

Definition at line 35 of file MapUtilities.cpp.

{
    TArray<FAssetData> AssetDatas = GetAssetData(onlyAgrarsenseMapFolder);
 
    TArray<FString> mapPaths = TArray<FString>();
    for (int32 i = 0; i < AssetDatas.Num(); ++i)
    {
        FAssetData& mapAssetData = AssetDatas[i];
        auto name = mapAssetData.PackagePath.ToString();
        mapPaths.Add(name);
    }
 
#if WITH_EDITOR
    if (logResults)
    {
        UE_LOG(LogTemp, Warning, TEXT("Found %d maps. Map paths:"), AssetDatas.Num());
        for (int i = 0; i < mapPaths.Num(); i++)
        {
            UE_LOG(LogTemp, Warning, TEXT("%s"), *mapPaths[i]);
        }
    }
#endif
 
    return mapPaths;
}

References GetAssetData().

GetAssetData()

TArray< FAssetData > UMapUtilities::GetAssetData ( bool  onlyAgrarsenseMapFolder )

staticprivate

Private function to actually retrieve the maps FAssetData

Parameters

onlyAgrarsenseMapFolder

Should we only look up path where all Agrarsense maps are or the entire Unreal project

Returns

array of maps FAssetData

Definition at line 68 of file MapUtilities.cpp.

{
    FString path = "/Game/";            // Search the whole project
    if (onlyAgrarsenseMapFolder)
    {
        path = "/Game/Agrarsense/Maps"; // Search only in Agrarsense map folder
    }
 
    auto ObjectLibrary = UObjectLibrary::CreateLibrary(UWorld::StaticClass(), false, true);
    ObjectLibrary->LoadAssetDataFromPath(path);
    TArray<FAssetData> AssetDatas;
    ObjectLibrary->GetAssetDataList(AssetDatas);
 
    return AssetDatas;
}

Referenced by GetAllMapAssetDatas(), GetAllMapNames(), and GetAllMapPaths().

---

The documentation for this class was generated from the following files:

• Unreal/Agrarsense/Source/Agrarsense/Utils/MapUtilities.h
• Unreal/Agrarsense/Source/Agrarsense/Utils/MapUtilities.cpp