USingleMenuSystemWidget Class Reference

#include <SingleMenuSystemWidget.h>

Inheritance diagram for USingleMenuSystemWidget:

Public Member Functions
	USingleMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
virtual UWidget *	NativeGetDesiredFocusTarget () const override
virtual bool	NativeOnHandleBackAction () override
virtual void	NativeOnActivated () override
virtual void	NativeOnDeactivated () override
void	DisableAllButtons () const
void	SetAllButtonsToAltText ()
void	SetIsBackHandler (const bool bValue)
void	SetMenuIndex (const int32 Index)
int32	GetMenuIndex () const
int32	CheckButtonFocus () const
void	ButtonSelectedEvent (const int32 Index)
void	CreateSelectionButtons ()
void	SetFromSingleMenuData (const FSingleMenu &SingleMenu)
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

Public Attributes
FOnMenuButtonSelected	OnMenuButtonSelected
FOnMenuButtonWithTabSelected	OnMenuButtonWithTabSelected
FString	MenuTitle = "Menu Title"
FString	DescriptionTitle = "Description"
TArray< FString >	ButtonTextList
TArray< FString >	AltButtonTextList
TArray< bool >	DisabledButtons
TArray< bool >	AltTextButtons
float	SpacerSize = 17.0f
int32	BackButtonIndex = 5
int32	Layout = 1
Public Attributes inherited from UMenuSystemWidget
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Protected Member Functions
virtual bool	Initialize () override
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
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
class UButton *	BackgroundButton = nullptr
class UStackBox *	MenuButtons = nullptr
class UTextBlock *	MenuTitleText = 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 Member Functions
void	BackgroundSelected ()
void	MenuButtonClicked (const int32 Index)

Private Attributes
int32	MenuIndex = 0
TSubclassOf< class UUserWidget >	SelectionButtonClass

Constructor & Destructor Documentation

USingleMenuSystemWidget()

USingleMenuSystemWidget::USingleMenuSystemWidget ( const FObjectInitializer & ObjectInitializer )

explicit

    : Super(ObjectInitializer)
{
    const ConstructorHelpers::FClassFinder<UUserWidget> SelectionButtonBP(TEXT("/MenuSystem/Widgets/CommonUI/WBP_SelectionButton"));
    if (!ensure(SelectionButtonBP.Class != nullptr)) return;
    SelectionButtonClass = SelectionButtonBP.Class;
    bIsBackHandler = true;
}

Member Function Documentation

BackgroundSelected()

void USingleMenuSystemWidget::BackgroundSelected ( )

private

{
}

ButtonSelectedEvent()

void USingleMenuSystemWidget::ButtonSelectedEvent

(

const int32

Index

)

CheckButtonFocus()

int32 USingleMenuSystemWidget::CheckButtonFocus

(

)

const

{
    for(int32 i = 0; i < MenuButtons->GetChildrenCount(); i++)
    {
        const USelectionButtonMenuSystem* SelectionButton = Cast<USelectionButtonMenuSystem>(MenuButtons->GetChildAt(i));
        if(SelectionButton != nullptr)
        {
            if(SelectionButton->IsVisible() && !SelectionButton->GetIsDisabled())
            {
                return SelectionButton->GetButtonIndex();
            }
        }
    }
    return 0;
}

CreateSelectionButtons()

void USingleMenuSystemWidget::CreateSelectionButtons

(

)

{
    MenuTitleText->SetText(FText::FromString(MenuTitle));
    if(ButtonTextList.IsEmpty()){return;}
    
    MenuButtons->ClearChildren();
    if(SelectionButtonClass.Get() == nullptr){return;}
    for(int32 i = 0; i < ButtonTextList.Num(); i++)
    {
        USelectionButtonMenuSystem* SelectionButton = WidgetTree->ConstructWidget<USelectionButtonMenuSystem>(SelectionButtonClass.Get());
        if(SelectionButton == nullptr){continue;}
        
        if(!ButtonTextList[i].IsEmpty())
        {
            SelectionButton->SetButtonText(ButtonTextList[i]);
            //- Set to alt Text if the bool is set in the array //
            if(AltTextButtons.IsValidIndex(i) && AltTextButtons[i] && AltButtonTextList.IsValidIndex(i))
            {
                if(!AltButtonTextList[i].IsEmpty())
                {
                    SelectionButton->SetButtonText(AltButtonTextList[i]);
                }
                else
                {
                    SelectionButton->SetButtonText("");
                    SelectionButton->SetVisibility(ESlateVisibility::Hidden);                       
                }
            }
            SelectionButton->SetButtonIndex(i);
            if(DisabledButtons.IsValidIndex(i))
            {
                SelectionButton->SetDisabled(DisabledButtons[i]);
            }
        }
        else
        {
            if(AltTextButtons.IsValidIndex(i) && AltTextButtons[i] && AltButtonTextList.IsValidIndex(i))
            {
                if(!AltButtonTextList[i].IsEmpty())
                {
                    SelectionButton->SetButtonText(AltButtonTextList[i]);
                }
                else
                {
                    SelectionButton->SetButtonText("");
                    SelectionButton->SetVisibility(ESlateVisibility::Hidden);                       
                }
                SelectionButton->SetButtonIndex(i);
                if(DisabledButtons.IsValidIndex(i))
                {
                    SelectionButton->SetDisabled(DisabledButtons[i]);
                }
            }
            else
            {
                //- Hide button but leave space //
                SelectionButton->SetVisibility(ESlateVisibility::Hidden);                       
            }
        }
        SelectionButton->OnSelectionButtonClicked.AddDynamic(this, &USingleMenuSystemWidget::MenuButtonClicked);
        MenuButtons->AddChild(SelectionButton);
        USpacer* Spacer = WidgetTree->ConstructWidget<USpacer>(USpacer::StaticClass());
        if(Spacer != nullptr)
        {
            Spacer->SetSize(FVector2D(SpacerSize,SpacerSize));
            MenuButtons->AddChild(Spacer);
        }
    }
}

DisableAllButtons()

void USingleMenuSystemWidget::DisableAllButtons

(

)

const

{
    for(int32 i = 0; i < MenuButtons->GetChildrenCount(); i++)
    {
        USelectionButtonMenuSystem* SelectionButton = Cast<USelectionButtonMenuSystem>(MenuButtons->GetChildAt(i));
        if(SelectionButton != nullptr)
        {
            SelectionButton->SetDisabled();
        }
    }
}

GetMenuIndex()

int32 USingleMenuSystemWidget::GetMenuIndex ( ) const

inline

{return MenuIndex;};

Initialize()

bool USingleMenuSystemWidget::Initialize ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(BackgroundButton != nullptr)) return false;
    if (!ensure(MenuButtons != nullptr)) return false;
    if (!ensure(MenuTitleText != nullptr)) return false;
    BackgroundButton->OnClicked.AddDynamic(this, &USingleMenuSystemWidget::BackgroundSelected);
    return true;
}

MenuButtonClicked()

void USingleMenuSystemWidget::MenuButtonClicked ( const int32 Index )

private

{
    ButtonSelectedEvent(Index);
    OnMenuButtonSelected.Broadcast(Index);
    OnMenuButtonWithTabSelected.Broadcast(Index, MenuIndex);
    if(Index == BackButtonIndex)
    {
        OnMenuBackButtonSelected.Broadcast(false);
    }
}

NativeConstruct()

void USingleMenuSystemWidget::NativeConstruct ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

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

NativeGetDesiredFocusTarget()

UWidget * USingleMenuSystemWidget::NativeGetDesiredFocusTarget ( ) const

overridevirtual

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

NativeOnActivated()

void USingleMenuSystemWidget::NativeOnActivated ( )

overridevirtual

{
    Super::NativeOnActivated();
    for(int32 i = 0; i < MenuButtons->GetChildrenCount(); i++)
    {
        USelectionButtonMenuSystem* SelectionButton = Cast<USelectionButtonMenuSystem>(MenuButtons->GetChildAt(i));
        if(SelectionButton != nullptr)
        {
            SelectionButton->SetTempDisabled(false);
        }
    }
}

NativeOnDeactivated()

void USingleMenuSystemWidget::NativeOnDeactivated ( )

overridevirtual

{
    Super::NativeOnDeactivated();
    for(int32 i = 0; i < MenuButtons->GetChildrenCount(); i++)
    {
        USelectionButtonMenuSystem* SelectionButton = Cast<USelectionButtonMenuSystem>(MenuButtons->GetChildAt(i));
        if(SelectionButton != nullptr)
        {
            SelectionButton->SetTempDisabled(true);
        }
    }
}

NativeOnHandleBackAction()

bool USingleMenuSystemWidget::NativeOnHandleBackAction ( )

overridevirtual

Reimplemented from UMenuSystemWidget.

{
    OnMenuBackButtonSelected.Broadcast(false);
    return Super::NativeOnHandleBackAction();
}

NativePreConstruct()

void USingleMenuSystemWidget::NativePreConstruct ( )

overrideprotectedvirtual

{
    Super::NativePreConstruct();
    CreateSelectionButtons();
}

SetAllButtonsToAltText()

void USingleMenuSystemWidget::SetAllButtonsToAltText

(

)

{
    for(int32 i = 0; i < MenuButtons->GetChildrenCount(); i++)
    {
        AltTextButtons[i] = true;
    }
    CreateSelectionButtons();
}

SetFromSingleMenuData()

void USingleMenuSystemWidget::SetFromSingleMenuData

(

const FSingleMenu &

SingleMenu

)

{
    MenuTitle = SingleMenu.MenuTitle;
    DescriptionTitle = SingleMenu.DescriptionTitle;
    ButtonTextList = SingleMenu.ButtonTextList;
    AltButtonTextList = SingleMenu.AltButtonTextList;
    DisabledButtons = SingleMenu.DisabledButtons;
    AltTextButtons = SingleMenu.AltTextButtons;
    SpacerSize = SingleMenu.SpacerSize;
    BackButtonIndex = SingleMenu.BackButtonIndex;
    Layout = SingleMenu.Layout;
    CreateSelectionButtons();
}

SetIsBackHandler()

void USingleMenuSystemWidget::SetIsBackHandler

(

const bool

bValue

)

{
    bIsBackHandler = bValue;
}

SetMenuIndex()

void USingleMenuSystemWidget::SetMenuIndex ( const int32 Index )

inline

{MenuIndex = Index;};

Member Data Documentation

AltButtonTextList

TArray<FString> USingleMenuSystemWidget::AltButtonTextList

AltTextButtons

TArray<bool> USingleMenuSystemWidget::AltTextButtons

BackButtonIndex

int32 USingleMenuSystemWidget::BackButtonIndex = 5

BackgroundButton

class UButton* USingleMenuSystemWidget::BackgroundButton = nullptr

protected

ButtonTextList

TArray<FString> USingleMenuSystemWidget::ButtonTextList

DescriptionTitle

FString USingleMenuSystemWidget::DescriptionTitle = "Description"

DisabledButtons

TArray<bool> USingleMenuSystemWidget::DisabledButtons

Layout

int32 USingleMenuSystemWidget::Layout = 1

MenuButtons

class UStackBox* USingleMenuSystemWidget::MenuButtons = nullptr

protected

MenuIndex

int32 USingleMenuSystemWidget::MenuIndex = 0

private

MenuTitle

FString USingleMenuSystemWidget::MenuTitle = "Menu Title"

MenuTitleText

class UTextBlock* USingleMenuSystemWidget::MenuTitleText = nullptr

protected

OnMenuButtonSelected

FOnMenuButtonSelected USingleMenuSystemWidget::OnMenuButtonSelected

OnMenuButtonWithTabSelected

FOnMenuButtonWithTabSelected USingleMenuSystemWidget::OnMenuButtonWithTabSelected

SelectionButtonClass

TSubclassOf<class UUserWidget> USingleMenuSystemWidget::SelectionButtonClass

private

SpacerSize

float USingleMenuSystemWidget::SpacerSize = 17.0f

---

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

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