UMenuBPLib Class Reference

#include <MenuBPLib.h>

Inheritance diagram for UMenuBPLib:

Static Public Member Functions
static EDifficultyLevel	GetCurrentDifficultyLevel (const UObject *WorldContextObject)
static FString	GetCurrentDifficultyLevelString (const UObject *WorldContextObject)
static void	QuitGame (APlayerController *PlayerController)
static TArray< FGameLevel >	GetAllGameLevels (const UObject *WorldContextObject, const bool bIncludeDebugLevels=false)
static TArray< FGameLevel >	GetAllCampaignLevels (const UObject *WorldContextObject, const bool bIncludeDebugLevels=false)
static TArray< FGameLevel >	GetAllMultiplayerLevels (const UObject *WorldContextObject, const bool bIncludeDebugLevels=false)
static TArray< FGameLevel >	GetAllHordeLevels (const UObject *WorldContextObject, const bool bIncludeDebugLevels=false)
static FGameLevel	GetDefaultLevel (const UObject *WorldContextObject, const EGameplayMode GameplayMode=EGameplayMode::Multiplayer)
static bool	GetGameDebuggingMode (const UObject *WorldContextObject)

Member Function Documentation

GetAllCampaignLevels()

TArray< FGameLevel > UMenuBPLib::GetAllCampaignLevels ( const UObject * WorldContextObject, const bool bIncludeDebugLevels = false )

static

{
    TArray<FGameLevel> GameLevels;
    TArray<FGameLevel> AllGameLevels = GetAllGameLevels(WorldContextObject, bIncludeDebugLevels);
    for(const auto GameLevel : AllGameLevels)
    {
        if(GameLevel.bCampaignPlayable)
        {
            GameLevels.Add(GameLevel);
        }
    }
    return GameLevels;
}

GetAllGameLevels()

TArray< FGameLevel > UMenuBPLib::GetAllGameLevels ( const UObject * WorldContextObject, const bool bIncludeDebugLevels = false )

static

{
    TArray<FGameLevel> GameLevels;
    const UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::LogAndReturnNull);
    if(World != nullptr)
    {
        ILevelSelectInterface* LevelSelectInterface = Cast<ILevelSelectInterface>(World->GetGameInstance());
        if(LevelSelectInterface != nullptr)
        {
            //- Get Data table of all Levels    //
            const UDataTable* LevelDataTable = LevelSelectInterface->GetLevelDataTable();
            if(LevelDataTable != nullptr)
            {
                TArray<FGameLevel*> AllGameLevels;
                const FString ContextString = TEXT("Loading All Game Levels");
                LevelDataTable->GetAllRows<FGameLevel>(ContextString, AllGameLevels);
                for(const auto GameLevel : AllGameLevels)
                {
                    if(!GameLevel->bDebugMap || bIncludeDebugLevels)
                    {
                        GameLevels.Add(*GameLevel);
                    }
                }
            }
        }
    }
    return GameLevels;
}

GetAllHordeLevels()

TArray< FGameLevel > UMenuBPLib::GetAllHordeLevels ( const UObject * WorldContextObject, const bool bIncludeDebugLevels = false )

static

{
    TArray<FGameLevel> GameLevels;
    TArray<FGameLevel> AllGameLevels = GetAllGameLevels(WorldContextObject, bIncludeDebugLevels);
    for(const auto GameLevel : AllGameLevels)
    {
        if(GameLevel.bHordePlayable)
        {
            GameLevels.Add(GameLevel);
        }
    }
    return GameLevels;
}

GetAllMultiplayerLevels()

TArray< FGameLevel > UMenuBPLib::GetAllMultiplayerLevels ( const UObject * WorldContextObject, const bool bIncludeDebugLevels = false )

static

{
    TArray<FGameLevel> GameLevels;
    TArray<FGameLevel> AllGameLevels = GetAllGameLevels(WorldContextObject, bIncludeDebugLevels);
    for(const auto GameLevel : AllGameLevels)
    {
        if(GameLevel.bMultiplayerPlayable)
        {
            GameLevels.Add(GameLevel);
        }
    }
    return GameLevels;
}

GetCurrentDifficultyLevel()

EDifficultyLevel UMenuBPLib::GetCurrentDifficultyLevel ( const UObject * WorldContextObject )

static

{
    const UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::LogAndReturnNull);
    if(World != nullptr)
    {
        IDifficultyInterface* DifficultyInterface = Cast<IDifficultyInterface>(World->GetGameInstance());
        if(DifficultyInterface != nullptr)
        {
            return DifficultyInterface->GetDifficultyLevel();
        }
    }
    return EDifficultyLevel::Normal;
}

GetCurrentDifficultyLevelString()

FString UMenuBPLib::GetCurrentDifficultyLevelString ( const UObject * WorldContextObject )

static

{
    const EDifficultyLevel DifficultyLevel = GetCurrentDifficultyLevel(WorldContextObject);
    switch (DifficultyLevel)
    {
    case EDifficultyLevel::Assisted:
        return "Assisted";
    case EDifficultyLevel::Easy:
        return "Easy";
    case EDifficultyLevel::Normal:
        return "Normal";
    case EDifficultyLevel::Hard:
        return "Hard";
    case EDifficultyLevel::Expert:
        return "Expert";
    case EDifficultyLevel::Master:
        return "Master";
    default:
        return "Normal";
    }
    
}

GetDefaultLevel()

FGameLevel UMenuBPLib::GetDefaultLevel ( const UObject * WorldContextObject, const EGameplayMode GameplayMode = EGameplayMode::Multiplayer )

static

{
    TArray<FGameLevel> GameLevels;
    switch (GameplayMode)
    {
    case EGameplayMode::Campaign:
        GameLevels = GetAllCampaignLevels(WorldContextObject, false);
        break;
    case EGameplayMode::Horde:
        GameLevels = GetAllHordeLevels(WorldContextObject, false);
        break;
    case EGameplayMode::Debug:
        GameLevels = GetAllGameLevels(WorldContextObject, false);
        break;
    case EGameplayMode::Multiplayer:
    default:
        GameLevels = GetAllMultiplayerLevels(WorldContextObject, false);
        break;
    }
    for(const auto GameLevel : GameLevels)
    {
        if(GameLevel.bDefaultMap)
        {
            return GameLevel;
        }
    }
    FGameLevel DefaultGameLevel;
    return DefaultGameLevel;
 
}

GetGameDebuggingMode()

bool UMenuBPLib::GetGameDebuggingMode ( const UObject * WorldContextObject )

static

{
    const UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject, EGetWorldErrorMode::LogAndReturnNull);
    if(World != nullptr)
    {
        const IMenuSystem* MenuInterface = Cast<IMenuSystem>(World->GetGameInstance());
        if(MenuInterface != nullptr)
        {
            return MenuInterface->GetDebuggingMode();
        }
    }
    return false;
}

QuitGame()

void UMenuBPLib::QuitGame ( APlayerController * PlayerController )

static

{
    if(PlayerController == nullptr){UE_LOG(LogMenuSystem,Warning,TEXT("PlayerController NULLPTR"));}
    UKismetSystemLibrary::QuitGame(PlayerController, PlayerController, EQuitPreference::Quit, false);
}

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Public/BPLib/MenuBPLib.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Private/BPLib/MenuBPLib.cpp