UInGameMenuSystemWidget Class Reference

#include <InGameMenuSystemWidget.h>

Inheritance diagram for UInGameMenuSystemWidget:

Public Member Functions
void	LeaveMultiplayerGame ()
virtual UWidget *	NativeGetDesiredFocusTarget () const override
Public Member Functions inherited from UMenuSystemWidget
	UMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
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
virtual void	NativeConstruct () override
virtual void	ModalButtonSelected (const int32 Index) override
virtual void	ModalClosed () override
virtual void	NativeOnActivated () override
virtual void	NativeOnDeactivated () override
virtual bool	NativeOnHandleBackAction () override
void	BackButtonClicked ()
void	RestartLevelButtonClicked ()
Protected Member Functions inherited from UMenuSystemWidget
void	OnModalButtonSelectedEvent (const int32 Index)
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
class USingleMenuSystemWidget *	PauseMenu = nullptr
TArray< bool >	MultiplayerButtons = { false, false, true, true, true }
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 Member Functions
void	PauseMenuButtonSelected (const int32 Index)
void	OpenOptionsMenu ()
void	MainMenuButtonClicked ()
void	OpenScoreboard ()
void	SaveGame ()
void	ExitGame ()

Additional Inherited Members
Public Attributes inherited from UMenuSystemWidget
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Member Function Documentation

BackButtonClicked()

void UInGameMenuSystemWidget::BackButtonClicked ( )

protected

{
    if(MenuInterface == nullptr){return;}
    APlayerController* PlayerControllerReference = GetOwningPlayer();
    if (!ensure(PlayerControllerReference != nullptr)) return;
    MenuInterface->LaunchInGameMenu(PlayerControllerReference, false);
}

ExitGame()

void UInGameMenuSystemWidget::ExitGame ( )

private

{
    const UWorld* World = GetWorld();
    if(!ensure(World != nullptr)) return;
    APlayerController* PlayerControllerReference = GetOwningPlayer();
    if(!ensure(PlayerControllerReference != nullptr)) return;
    if(World->GetNetMode() == NM_ListenServer) 
    {
        AGameModeBase* GameMode = World->GetAuthGameMode<AGameModeBase>();
        if(GameMode)
        {
            LeaveMultiplayerGame();
            GameMode->ReturnToMainMenuHost();
        }
    } 
    else 
    {
        if (PlayerControllerReference) 
        {
            LeaveMultiplayerGame();
            PlayerControllerReference->ClientReturnToMainMenuWithTextReason(FText::FromString("Back to main menu"));
        }
    }
}

Initialize()

bool UInGameMenuSystemWidget::Initialize ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    PauseMenu->OnMenuButtonSelected.AddUniqueDynamic(this, &UInGameMenuSystemWidget::PauseMenuButtonSelected);
    bIsBackHandler = true;
    return true;
}

LeaveMultiplayerGame()

void UInGameMenuSystemWidget::LeaveMultiplayerGame

(

)

{
    if(MenuInterface != nullptr)
    {
        MenuInterface->DestroySession();
    }
}

MainMenuButtonClicked()

void UInGameMenuSystemWidget::MainMenuButtonClicked ( )

private

{
    const FModalData ModalData = FModalData(true);
    OpenConfirmationMessage(ModalData);
    DeactivateWidget();
}

ModalButtonSelected()

void UInGameMenuSystemWidget::ModalButtonSelected ( const int32 Index )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    Super::ModalButtonSelected(Index);
    if(GetCurrentModal() != nullptr)
    {
        if(Index == GetCurrentModal()->GetMainButtonIndex())
        {
            ExitGame();
            return;
        }
        GetCurrentModal()->CloseWindow();
        ActivateWidget();
    }
}

ModalClosed()

void UInGameMenuSystemWidget::ModalClosed ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    Super::ModalClosed();
    ActivateWidget();
}

NativeConstruct()

void UInGameMenuSystemWidget::NativeConstruct ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    Super::NativeConstruct();
    if(GetIsOnlineGame())
    {
        PauseMenu->AltTextButtons = MultiplayerButtons;
        PauseMenu->CreateSelectionButtons();
    }
}

NativeGetDesiredFocusTarget()

UWidget * UInGameMenuSystemWidget::NativeGetDesiredFocusTarget ( ) const

overridevirtual

{
    if(PauseMenu != nullptr)
    {
        return PauseMenu->GetDesiredFocusTarget();
    }
    return Super::NativeGetDesiredFocusTarget();
}

NativeOnActivated()

void UInGameMenuSystemWidget::NativeOnActivated ( )

overrideprotectedvirtual

{
    Super::NativeOnActivated();
    if(PauseMenu != nullptr)
    {
        PauseMenu->ActivateWidget();
    }
}

NativeOnDeactivated()

void UInGameMenuSystemWidget::NativeOnDeactivated ( )

overrideprotectedvirtual

{
    Super::NativeOnDeactivated();
    if(PauseMenu != nullptr)
    {
        PauseMenu->DeactivateWidget();
    }
}

NativeOnHandleBackAction()

bool UInGameMenuSystemWidget::NativeOnHandleBackAction ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    BackButtonClicked();
    return Super::NativeOnHandleBackAction();
}

OpenOptionsMenu()

void UInGameMenuSystemWidget::OpenOptionsMenu ( )

private

{
    if(MenuInterface != nullptr && GetOwningPlayer() != nullptr)
    {
        MenuInterface->LaunchOptionsMenu(GetOwningPlayer(), this);
    }
}

OpenScoreboard()

void UInGameMenuSystemWidget::OpenScoreboard ( )

private

{
    //@TODO Open scoreboard //
    if(GetDebuggingMode()){UE_LOG(LogMenuSystem, Warning, TEXT("Open Scoreboard"));}
}

PauseMenuButtonSelected()

void UInGameMenuSystemWidget::PauseMenuButtonSelected ( const int32 Index )

private

{
    switch (Index)
    {
    default:
    case 0:
        //-     Resume      //
        BackButtonClicked();
        break;
    case 1:
        //-     Options     //
        OpenOptionsMenu();
        break;
    case 2:
        //- Open Scoreboard //
        if(GetIsOnlineGame())
        {
            OpenScoreboard();
            return;
        }
        //-     Save Game       //
        SaveGame();
        break;
    case 3:
        //-         //
        if(GetIsOnlineGame())
        {
        
            return;
        }
        //- Load Last Checkpoint?       //
 
        //@TODO Load Checkpoint //
        break;
    case 4:
        //- Restart Level   //
            RestartLevelButtonClicked();
        break;
    case 5:
        //-     Main Menu       //
        MainMenuButtonClicked();
        break;
    case 6:
        break;
    }
}

RestartLevelButtonClicked()

void UInGameMenuSystemWidget::RestartLevelButtonClicked ( )

protected

{
    if(MenuInterface != nullptr)
    {
        MenuInterface->RestartLevel();
    }
    BackButtonClicked();
}

SaveGame()

void UInGameMenuSystemWidget::SaveGame ( )

private

{
    //@TODO Save Game   //
    if(GetDebuggingMode()){UE_LOG(LogMenuSystem, Warning, TEXT("Save Game"));}
}

Member Data Documentation

MultiplayerButtons

TArray<bool> UInGameMenuSystemWidget::MultiplayerButtons = { false, false, true, true, true }

protected

{ false, false, true, true, true };

PauseMenu

class USingleMenuSystemWidget* UInGameMenuSystemWidget::PauseMenu = nullptr

protected

---

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

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