ULevelSelectionWidget Class Reference

#include <LevelSelectionWidget.h>

Inheritance diagram for ULevelSelectionWidget:

Public Member Functions
	ULevelSelectionWidget (const FObjectInitializer &ObjectInitializer)
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
void	SelectIndex (const uint32 Index, const FGameLevel &GameLevel)
void	SetMode (const EGameplayMode Mode, const bool bDebugLevels=false)
void	SetLevelList (const TArray< FGameLevel > &GameLevels)
void	GetLastSelectedLevel ()
virtual UWidget *	NativeGetDesiredFocusTarget () const override
Public Member Functions inherited from UMenuSystemWidget
	UMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
virtual bool	NativeOnHandleBackAction () override
void	SetMenuInterface (IMenuSystem *Interface)
void	Setup ()
virtual void	OpenConfirmationMessage (const FModalData &ModalData)
virtual void	SetServerList (const TArray< FServerRow > &ServerInfo)
void	SetOwnerWidget (UUserWidget *Owner)
UUserWidget *	GetOwnerWidget () const
void	WidgetVisibilityChanged (ESlateVisibility SlateVisibility)
bool	GetIsOnlineGame () const
bool	GetIsPublicMatch () const
virtual bool	GetDebuggingMode () const
virtual FString	GetPlayerUserName () const
virtual bool	GetIsPlayerLoggedIn () const
virtual FString	GetCurrentSessionName () const
virtual EOnlineSubsystem	GetOnlineSubsystem () const

Protected Member Functions
virtual bool	Initialize () override
void	OnBackButtonClicked ()
void	UpdateLevelSelection ()
Protected Member Functions inherited from UMenuSystemWidget
virtual void	ModalButtonSelected (const int32 Index)
void	OnModalButtonSelectedEvent (const int32 Index)
virtual void	ModalClosed ()
void	OnModalClosedEvent ()
class UModalMenuSystemWidget *	GetCurrentModal () const
void	SetModalSlot (UPanelWidget *PanelWidget)
void	SetNotificationSlot (UPanelWidget *PanelWidget)
Protected Member Functions inherited from UBaseActivatableWidget
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Protected Attributes
TOptional< uint32 >	SelectedIndex
FGameLevel	SelectedGameLevel
class UPanelWidget *	LevelList = nullptr
class UButton *	CloseButton = nullptr
Protected Attributes inherited from UMenuSystemWidget
IMenuSystem *	MenuInterface = nullptr
class IModalInterface *	ModalInterface = nullptr
bool	bIsController = false
bool	bIsKeyboard = false
bool	bMouse = false
Protected Attributes inherited from UBaseActivatableWidget
bool	bDebuggingMode = false

Private Attributes
EGameplayMode	GameplayMode = EGameplayMode::Multiplayer
TSubclassOf< class UUserWidget >	LevelSelectSingleClass

Additional Inherited Members
Public Attributes inherited from UMenuSystemWidget
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Detailed Description

This is a menu system widget used for level selection.

Constructor & Destructor Documentation

ULevelSelectionWidget()

ULevelSelectionWidget::ULevelSelectionWidget

(

const FObjectInitializer &

ObjectInitializer

)

    : Super(ObjectInitializer)
{
    const ConstructorHelpers::FClassFinder<UUserWidget> LevelSelectSingleBP(TEXT("/MenuSystem/Widgets/CommonUI/WBP_LevelSelectionSingle"));
    if (!ensure(LevelSelectSingleBP.Class != nullptr)) return;
    LevelSelectSingleClass = LevelSelectSingleBP.Class;
 
}

Member Function Documentation

GetLastSelectedLevel()

void ULevelSelectionWidget::GetLastSelectedLevel

(

)

{
    if(GetGameInstance() != nullptr)
    {
        const ILevelSelectInterface* LevelSelectInterface = Cast<ILevelSelectInterface>(GetGameInstance());
        if(LevelSelectInterface != nullptr)
        {
            const FGameLevel LastSelectedLevel = LevelSelectInterface->GetSelectedLevel(GameplayMode);
            if(LastSelectedLevel.IsValid())
            {
                SelectedGameLevel = LastSelectedLevel;
            }
        }
    }   
}

Initialize()

bool ULevelSelectionWidget::Initialize ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(LevelList != nullptr)) return false;
    if (!ensure(CloseButton != nullptr)) return false;
 
 
    CloseButton->OnClicked.AddUniqueDynamic(this, &ULevelSelectionWidget::OnBackButtonClicked);
    return true;
}

NativeConstruct()

void ULevelSelectionWidget::NativeConstruct ( )

overridevirtual

Reimplemented from UMenuSystemWidget.

{
    Super::NativeConstruct();
    GetLastSelectedLevel();
}

NativeGetDesiredFocusTarget()

UWidget * ULevelSelectionWidget::NativeGetDesiredFocusTarget ( ) const

overridevirtual

{
    for(int32 i = 0; i < LevelList->GetChildrenCount(); i++)
    {
        ULevelSelectionSingleWidget* LevelSelection = Cast<ULevelSelectionSingleWidget>(LevelList->GetChildAt(i));
        if(LevelSelection != nullptr)
        {
            if(LevelSelection->IsVisible() /*&& !LevelSelection->GetIsDisabled()*/)
            {
                return LevelSelection;
            }
        }
    }
    return Super::NativeGetDesiredFocusTarget();
}

NativePreConstruct()

void ULevelSelectionWidget::NativePreConstruct ( )

overridevirtual

{
    Super::NativePreConstruct();
}

OnBackButtonClicked()

void ULevelSelectionWidget::OnBackButtonClicked ( )

protected

{
    if(SelectedGameLevel.IsValid() && GetGameInstance() != nullptr)
    {
        ILevelSelectInterface* LevelSelectInterface = Cast<ILevelSelectInterface>(GetGameInstance());
        if(LevelSelectInterface != nullptr)
        {
            LevelSelectInterface->SetSelectedLevel(SelectedGameLevel, GameplayMode);
        }
    }
    OnMenuBackButtonSelected.Broadcast(false);
    SetVisibility(ESlateVisibility::Collapsed);
}

SelectIndex()

void ULevelSelectionWidget::SelectIndex	(	const uint32	Index,
		const FGameLevel &	GameLevel )

{
    SelectedIndex = Index;
    SelectedGameLevel = GameLevel;
    UpdateLevelSelection();
}

SetLevelList()

void ULevelSelectionWidget::SetLevelList

(

const TArray< FGameLevel > &

GameLevels

)

{
    LevelList->ClearChildren();
    uint32 i = 0;
    for(const auto GameLevel : GameLevels)
    {
        if(GameLevel.IsValid())
        {
            ULevelSelectionSingleWidget* LevelSelectSingle = CreateWidget<ULevelSelectionSingleWidget>(GetOwningPlayer(), LevelSelectSingleClass);
            if(LevelSelectSingle != nullptr)
            {
                if(i == 0)
                {
                    LevelSelectSingle->SetFocus();
                    LevelSelectSingle->SetKeyboardFocus();
                }
                LevelSelectSingle->Setup(this, i);
                LevelSelectSingle->SetGameLevelData(GameLevel);
                ++i;
                LevelList->AddChild(LevelSelectSingle);
            }
        }
    }
    // SetFocusToFirstVisibleOption();
}

SetMode()

void ULevelSelectionWidget::SetMode	(	const EGameplayMode	Mode,
		const bool	bDebugLevels = false )

{
    GameplayMode = Mode;
    //- Get Game Levels //
    TArray<FGameLevel> AllGameLevels;
    TArray<FGameLevel> NewLevels;
    switch (GameplayMode)
    {
    case EGameplayMode::Campaign:
        NewLevels = UMenuBPLib::GetAllCampaignLevels(GetOwningPlayer(), bDebugLevels);
        for(auto GameLevel : NewLevels)
        {
            AllGameLevels.AddUnique(GameLevel);
        }
        break;
    case EGameplayMode::Horde:
        NewLevels = UMenuBPLib::GetAllHordeLevels(GetOwningPlayer(), bDebugLevels);
        for(auto GameLevel : NewLevels)
        {
            AllGameLevels.AddUnique(GameLevel);
        }
        break;
    case EGameplayMode::Debug:
        NewLevels = UMenuBPLib::GetAllGameLevels(GetOwningPlayer(), bDebugLevels);
        for(auto GameLevel : NewLevels)
        {
            AllGameLevels.AddUnique(GameLevel);
        }
        break;
    case EGameplayMode::Multiplayer:
    default:
        NewLevels = UMenuBPLib::GetAllMultiplayerLevels(GetOwningPlayer(), bDebugLevels);
        for(auto GameLevel : NewLevels)
        {
            AllGameLevels.AddUnique(GameLevel);
        }
        break;
    }
    SetLevelList(AllGameLevels);
}

UpdateLevelSelection()

void ULevelSelectionWidget::UpdateLevelSelection ( )

protected

{
    for (int32 i = 0; i < LevelList->GetChildrenCount(); ++i)
    {
        ULevelSelectionSingleWidget* LevelSelection = Cast<ULevelSelectionSingleWidget>(LevelList->GetChildAt(i));
        if(LevelSelection != nullptr)
        {
            const bool bIsSelected = (SelectedIndex.IsSet() && SelectedIndex.GetValue() == i);
            LevelSelection->SetAsSelected(bIsSelected);
        }
    }
}

Member Data Documentation

CloseButton

class UButton* ULevelSelectionWidget::CloseButton = nullptr

protected

GameplayMode

EGameplayMode ULevelSelectionWidget::GameplayMode = EGameplayMode::Multiplayer

private

LevelList

class UPanelWidget* ULevelSelectionWidget::LevelList = nullptr

protected

LevelSelectSingleClass

TSubclassOf<class UUserWidget> ULevelSelectionWidget::LevelSelectSingleClass

private

SelectedGameLevel

FGameLevel ULevelSelectionWidget::SelectedGameLevel

protected

SelectedIndex

TOptional<uint32> ULevelSelectionWidget::SelectedIndex

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Public/Widgets/CommonUI/LevelSelectionWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Private/Widgets/CommonUI/LevelSelectionWidget.cpp