UMenuSystemWidget Class Reference

#include <MenuSystemWidget.h>

Inheritance diagram for UMenuSystemWidget:

Public Member Functions
	UMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
virtual bool	Initialize () override
virtual void	NativeConstruct () override
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

Public Attributes
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Protected Member Functions
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
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
UUserWidget *	OwnerWidget = nullptr
class UPanelWidget *	ModalSlot = nullptr
class UPanelWidget *	NotificationSlot = nullptr
class UModalMenuSystemWidget *	Modal = nullptr

Constructor & Destructor Documentation

UMenuSystemWidget()

UMenuSystemWidget::UMenuSystemWidget ( const FObjectInitializer & ObjectInitializer )

explicit

    : Super(ObjectInitializer)
{
    
}

Member Function Documentation

GetCurrentModal()

class UModalMenuSystemWidget * UMenuSystemWidget::GetCurrentModal ( ) const

inlineprotected

{return Modal;};

GetCurrentSessionName()

FString UMenuSystemWidget::GetCurrentSessionName ( ) const

virtual

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetCurrentSessionName"));return "Error in Session Name, Check Log";}
    return MenuInterface->GetCurrentSessionName();
}

GetDebuggingMode()

bool UMenuSystemWidget::GetDebuggingMode ( ) const

virtual

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetDebuggingMode"));return false;}
    return MenuInterface->GetDebuggingMode();
}

GetIsOnlineGame()

bool UMenuSystemWidget::GetIsOnlineGame

(

)

const

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetIsOnlineGame"));return false;}
    return MenuInterface->GetIsOnlineGame();
}

GetIsPlayerLoggedIn()

bool UMenuSystemWidget::GetIsPlayerLoggedIn ( ) const

virtual

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetIsPlayerLoggedIn"));return false;}
    return MenuInterface->GetIsPlayerLoggedIn();
}

GetIsPublicMatch()

bool UMenuSystemWidget::GetIsPublicMatch

(

)

const

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetIsPublicMatch"));return false;}
    return MenuInterface->GetIsPublicMatch();
}

GetOnlineSubsystem()

EOnlineSubsystem UMenuSystemWidget::GetOnlineSubsystem ( ) const

virtual

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetOnlineSubsystem"));return EOnlineSubsystem::Null;}
    return MenuInterface->GetOnlineSubsystem();
}

GetOwnerWidget()

UUserWidget * UMenuSystemWidget::GetOwnerWidget ( ) const

inline

{return OwnerWidget;};

GetPlayerUserName()

FString UMenuSystemWidget::GetPlayerUserName ( ) const

virtual

{
    if(MenuInterface == nullptr){UE_LOG(LogMenuSystem, Error, TEXT("Menu Interface Missing, GetPlayerUserName"));return "Error in Player Name, Check Log";}
    return MenuInterface->GetPlayerUserName();
}

Initialize()

bool UMenuSystemWidget::Initialize ( )

overridevirtual

Reimplemented in ULevelSelectionWidget, USingleMenuWithTabsWidget, UInGameMenuSystemWidget, UMainMenuSystemWidget, UModalMenuSystemWidget, UOptionsMenuSystemWidget, UAudioOptionsWidget, and USingleMenuSystemWidget.

{
    OnVisibilityChanged.AddUniqueDynamic(this, &UMenuSystemWidget::WidgetVisibilityChanged);
    return Super::Initialize();
}

ModalButtonSelected()

void UMenuSystemWidget::ModalButtonSelected ( const int32 Index )

protectedvirtual

Reimplemented in UInGameMenuSystemWidget, and UMainMenuSystemWidget.

{
    OnModalButtonSelectedEvent(Index);
}

ModalClosed()

void UMenuSystemWidget::ModalClosed ( )

protectedvirtual

Reimplemented in UInGameMenuSystemWidget.

{
    OnModalClosedEvent();
    Modal = nullptr;
    ActivateWidget();
}

NativeConstruct()

void UMenuSystemWidget::NativeConstruct ( )

overridevirtual

Reimplemented in ULevelSelectionWidget, USingleMenuWithTabsWidget, UInGameMenuSystemWidget, UMainMenuSystemWidget, UModalMenuSystemWidget, UAudioOptionsWidget, and USingleMenuSystemWidget.

{
    Super::NativeConstruct();
    ModalInterface = Cast<IModalInterface>(GetGameInstance());
    MenuInterface = Cast<IMenuSystem>(GetGameInstance());
    if(ModalSlot != nullptr)
    {
        ModalSlot->ClearChildren();
    }
    if(NotificationSlot != nullptr)
    {
        NotificationSlot->ClearChildren();
    }
}

NativeOnHandleBackAction()

bool UMenuSystemWidget::NativeOnHandleBackAction ( )

overridevirtual

Reimplemented in UInGameMenuSystemWidget, UModalMenuSystemWidget, UOptionsMenuSystemWidget, and USingleMenuSystemWidget.

{
    // if(OwnerWidget != nullptr)
    // {
    //  UCommonActivatableWidget* CurrentActivatable = Cast<UCommonActivatableWidget>(OwnerWidget);
    //  if(CurrentActivatable != nullptr)
    //  {
    //      CurrentActivatable->SetVisibility(ESlateVisibility::Visible);
    //      CurrentActivatable->ActivateWidget();
    //  }
    //  DeactivateWidget();
    //  SetVisibility(ESlateVisibility::Collapsed);
    // }
    return Super::NativeOnHandleBackAction();
}

OnModalButtonSelectedEvent()

void UMenuSystemWidget::OnModalButtonSelectedEvent ( const int32 Index )

protected

OnModalClosedEvent()

void UMenuSystemWidget::OnModalClosedEvent ( )

protected

OpenConfirmationMessage()

void UMenuSystemWidget::OpenConfirmationMessage ( const FModalData & ModalData )

virtual

{
    if(ModalInterface == nullptr)
    {
        ModalInterface = Cast<IModalInterface>(GetGameInstance());
    }
    if(ModalInterface == nullptr || ModalInterface->GetModalWidgetClass() == nullptr){return;}
    if(ModalData.Style == EMenuSystemModalType::Notification && NotificationSlot != nullptr)
    {
        UModalMenuSystemWidget* Notification = CreateWidget<UModalMenuSystemWidget>(GetOwningPlayer(), ModalInterface->GetModalWidgetClass());
        Notification->SetValues(ModalData);
        NotificationSlot->AddChild(Notification);
        return;
    }
    if(Modal == nullptr)
    {
        Modal = CreateWidget<UModalMenuSystemWidget>(GetOwningPlayer(), ModalInterface->GetModalWidgetClass());
    }
    if(Modal != nullptr)
    {
        if(Modal->IsInViewport())
        {
            DeactivateWidget();
            Modal->ActivateWidget();
            return;
        }
        Modal->OnModalButtonSelected.AddUniqueDynamic(this, &UMenuSystemWidget::ModalButtonSelected);
        Modal->OnCloseModal.AddUniqueDynamic(this, &UMenuSystemWidget::ModalClosed);
        Modal->SetValues(ModalData);
        if(ModalData.Style != EMenuSystemModalType::Notification && ModalSlot != nullptr)
        {
            ModalSlot->ClearChildren();
            ModalSlot->AddChild(Modal);
            DeactivateWidget();
            Modal->ActivateWidget();
            return;
        }
        Modal->AddToViewport();
        DeactivateWidget();
        Modal->ActivateWidget();
    }
}

SetMenuInterface()

void UMenuSystemWidget::SetMenuInterface

(

IMenuSystem *

Interface

)

{
    MenuInterface = Interface;
}

SetModalSlot()

void UMenuSystemWidget::SetModalSlot ( UPanelWidget * PanelWidget )

inlineprotected

{ModalSlot = PanelWidget;};

SetNotificationSlot()

void UMenuSystemWidget::SetNotificationSlot ( UPanelWidget * PanelWidget )

inlineprotected

{NotificationSlot = PanelWidget;};

SetOwnerWidget()

void UMenuSystemWidget::SetOwnerWidget ( UUserWidget * Owner )

inline

{OwnerWidget = Owner;};

SetServerList()

void UMenuSystemWidget::SetServerList ( const TArray< FServerRow > & ServerInfo )

virtual

Reimplemented in UMainMenuSystemWidget.

{
    
}

Setup()

void UMenuSystemWidget::Setup

(

)

{
    AddToViewport();
    APlayerController* PlayerControllerReference = GetOwningPlayer();
 
    if (!ensure(PlayerControllerReference != nullptr)) return;
    FInputModeUIOnly InputModeData;
    InputModeData.SetLockMouseToViewportBehavior(EMouseLockMode::LockAlways);
    PlayerControllerReference->SetInputMode(InputModeData);
    PlayerControllerReference->bShowMouseCursor = true;
}

WidgetVisibilityChanged()

void UMenuSystemWidget::WidgetVisibilityChanged

(

ESlateVisibility

SlateVisibility

)

Member Data Documentation

bIsController

bool UMenuSystemWidget::bIsController = false

protected

bIsKeyboard

bool UMenuSystemWidget::bIsKeyboard = false

protected

bMouse

bool UMenuSystemWidget::bMouse = false

protected

MenuInterface

IMenuSystem* UMenuSystemWidget::MenuInterface = nullptr

protected

Modal

class UModalMenuSystemWidget* UMenuSystemWidget::Modal = nullptr

private

ModalInterface

class IModalInterface* UMenuSystemWidget::ModalInterface = nullptr

protected

ModalSlot

class UPanelWidget* UMenuSystemWidget::ModalSlot = nullptr

private

NotificationSlot

class UPanelWidget* UMenuSystemWidget::NotificationSlot = nullptr

private

OnMenuBackButtonSelected

FOnMenuBackButtonSelected UMenuSystemWidget::OnMenuBackButtonSelected

OwnerWidget

UUserWidget* UMenuSystemWidget::OwnerWidget = nullptr

private

---

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

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