UModalMenuSystemWidget Class Reference

#include <ModalMenuSystemWidget.h>

Inheritance diagram for UModalMenuSystemWidget:

Public Member Functions
	UModalMenuSystemWidget (const FObjectInitializer &ObjectInitializer)
virtual UWidget *	NativeGetDesiredFocusTarget () const override
virtual bool	NativeOnHandleBackAction () override
void	SetValues (const EMenuSystemModalAlert Alert, const EMenuSystemModalType Style, FString Title, FString Description, FString LeftText, FString RightText)
void	SetValues (const FModalData &Data)
void	CloseWindow ()
void	PlayOpenAnimation ()
void	PlayCloseAnimation ()
int32	GetCloseButtonIndex () const
int32	GetMainButtonIndex () const
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
FOnModalButtonSelected	OnModalButtonSelected
FOnCloseModal	OnCloseModal
FModalData	ModalData
Public Attributes inherited from UMenuSystemWidget
FOnMenuBackButtonSelected	OnMenuBackButtonSelected

Protected Member Functions
virtual bool	Initialize () override
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
void	OnButtonClicked (const int32 Index)
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 USoundBase *	DefaultOpenSound = nullptr
class USoundBase *	NotificationSound = nullptr
class USoundBase *	WarningSound = nullptr
class USoundBase *	ErrorSound = nullptr
FLinearColor	GeneralColor
FLinearColor	SystemColor
FLinearColor	WarningColor
FLinearColor	ErrorColor
float	SpacerSize = 17.0f
int32	CloseButtonIndex = 0
int32	MainButtonIndex = 1
float	NotificationLifetime = 3.0f
float	NotificationPadding = 5.0f
float	BorderPadding = 32.0f
class UHorizontalBox *	MainButtonContainer = nullptr
class UTextBlock *	DescriptionTextBlock = nullptr
class UTextBlock *	TitleTextBlock = nullptr
class UBorder *	ModalBorder = nullptr
class UVerticalBox *	MainVerticalBox = nullptr
class UHorizontalBox *	ButtonHorizontalBox = nullptr
class UBorder *	HighlightColorBorder = nullptr
class UStackBox *	ExtraButtons = nullptr
class USelectionButtonMenuSystem *	CloseButton = nullptr
class USelectionButtonMenuSystem *	MainButton = 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	PlaySound (USoundBase *Sound) const
void	ApplySettings ()
void	SetModal ()
void	CreateExtraButtons ()

Private Attributes
ETextJustify::Type	JustifyType = ETextJustify::Left
FLinearColor	ColorType
TSubclassOf< class UUserWidget >	SelectionButtonClass
FTimerHandle	NotificationTimerHandle

Constructor & Destructor Documentation

UModalMenuSystemWidget()

UModalMenuSystemWidget::UModalMenuSystemWidget ( 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;
    bIsModal = true;
}

Member Function Documentation

ApplySettings()

void UModalMenuSystemWidget::ApplySettings ( )

private

{
    switch(ModalData.Style)
    {
    default:
    case EMenuSystemModalType::Popup1:
        JustifyType = ETextJustify::Left;
        break;
    case EMenuSystemModalType::Popup2:
        JustifyType = ETextJustify::Center;
        break;
    case EMenuSystemModalType::Popup3:
        JustifyType = ETextJustify::Center;
        break;
    case EMenuSystemModalType::Popup4:
        JustifyType = ETextJustify::Center;
        break;
        
    case EMenuSystemModalType::Notification:
        JustifyType = ETextJustify::Left;
        break;
    }
    switch(ModalData.Alert)
    {
    default:
    case EMenuSystemModalAlert::General:
        ColorType = GeneralColor;
        break;
    case EMenuSystemModalAlert::Error:
        ColorType = ErrorColor;
        break;
    case EMenuSystemModalAlert::System:
        ColorType = SystemColor;
        break;
    case EMenuSystemModalAlert::Warning:
        ColorType = WarningColor;
        break;
    }
    
    DescriptionTextBlock->SetJustification(JustifyType);
    TitleTextBlock->SetJustification(JustifyType);
    TitleTextBlock->SetText(FText::FromString(ModalData.Title));
    DescriptionTextBlock->SetText(FText::FromString(ModalData.Description));
 
    const FSlateColor CurrentColor(ColorType);
    TitleTextBlock->SetColorAndOpacity(CurrentColor);
    if(MainButton != nullptr)
    {
        MainButton->SetButtonText(ModalData.MainButtonText);
        MainButton->SetButtonIndex(MainButtonIndex);
    }
    if(CloseButton != nullptr)
    {
        CloseButton->SetButtonText(ModalData.CloseButtonText);
        CloseButton->SetButtonIndex(CloseButtonIndex);
    }
 
    HighlightColorBorder->SetBrushColor(ColorType);
    
    // TitleTextBlock->SetColorAndOpacity();
    if(ModalData.MainButtonText.IsEmpty())
    {
        MainButtonContainer->SetVisibility(ESlateVisibility::Collapsed);
    }
    
    if(ModalData.Alert == EMenuSystemModalAlert::Warning)
    {
        PlaySound(WarningSound);
    }
    if(ModalData.Alert == EMenuSystemModalAlert::Error)
    {
        PlaySound(ErrorSound);
    }
    if(ModalData.Style == EMenuSystemModalType::Notification)
    {
        PlaySound(NotificationSound);
        if(GetOwningPlayer() != nullptr)
        {
            GetOwningPlayer()->GetWorldTimerManager().SetTimer(NotificationTimerHandle, this, &UModalMenuSystemWidget::PlayCloseAnimation, NotificationLifetime);
        }
    }
    else
    {
        PlaySound(DefaultOpenSound);
    }
}

CloseWindow()

void UModalMenuSystemWidget::CloseWindow

(

)

{
    RemoveFromParent();
}

CreateExtraButtons()

void UModalMenuSystemWidget::CreateExtraButtons ( )

private

{
    if(SelectionButtonClass.Get() == nullptr){return;}
    if(!ModalData.ExtraButtons.IsEmpty())
    {
        ExtraButtons->ClearChildren();
        for(int i = 0; i < ModalData.ExtraButtons.Num(); i++)
        {
            USelectionButtonMenuSystem* SelectionButton = WidgetTree->ConstructWidget<USelectionButtonMenuSystem>(SelectionButtonClass.Get());
            if(SelectionButton != nullptr)
            {
                if(!ModalData.ExtraButtons[i].IsEmpty())
                {
                    SelectionButton->SetButtonText(ModalData.ExtraButtons[i]);
                    SelectionButton->SetButtonIndex(i + 2); //- Start Index after Main and Close Buttons    //
                    if(ModalData.DisabledExtraButtons.IsValidIndex(i))
                    {
                        SelectionButton->SetDisabled(ModalData.DisabledExtraButtons[i]);
                    }
                }
                else
                {
                    //- Hide button but leave space //
                    SelectionButton->SetVisibility(ESlateVisibility::Hidden);
                }
                SelectionButton->OnSelectionButtonClicked.AddUniqueDynamic(this, &UModalMenuSystemWidget::OnButtonClicked);
                ExtraButtons->AddChild(SelectionButton);
                USpacer* Spacer = WidgetTree->ConstructWidget<USpacer>(USpacer::StaticClass());
                if(Spacer != nullptr)
                {
                    Spacer->SetSize(FVector2D(SpacerSize,SpacerSize));
                    ExtraButtons->AddChild(Spacer);
                }
            }
        }
    }
}

GetCloseButtonIndex()

int32 UModalMenuSystemWidget::GetCloseButtonIndex ( ) const

inline

Set Styles for Modals 1 = Centered style

Parameters

{return CloseButtonIndex;};

GetMainButtonIndex()

int32 UModalMenuSystemWidget::GetMainButtonIndex ( ) const

inline

{return MainButtonIndex;};

Initialize()

bool UModalMenuSystemWidget::Initialize ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(CloseButton != nullptr)) return false;
    if (!ensure(MainButton != nullptr)) return false;
    if (!ensure(MainButtonContainer != nullptr)) return false;
    if (!ensure(DescriptionTextBlock != nullptr)) return false;
    if (!ensure(TitleTextBlock != nullptr)) return false;
    if (!ensure(HighlightColorBorder != nullptr)) return false;
    if (!ensure(ExtraButtons != nullptr)) return false;
    if (!ensure(ModalBorder != nullptr)) return false;
    if (!ensure(MainVerticalBox != nullptr)) return false;
    if (!ensure(ButtonHorizontalBox != nullptr)) return false;
    CloseButton->OnSelectionButtonClicked.AddDynamic(this, &UModalMenuSystemWidget::OnButtonClicked);
    MainButton->OnSelectionButtonClicked.AddDynamic(this, &UModalMenuSystemWidget::OnButtonClicked);
    return true;
}

NativeConstruct()

void UModalMenuSystemWidget::NativeConstruct ( )

overrideprotectedvirtual

Reimplemented from UMenuSystemWidget.

{
    Super::NativeConstruct();
    SetModal();
    if(ModalData.Style == EMenuSystemModalType::Notification)
    {
        PlayOpenAnimation();
        return;
    }
}

NativeGetDesiredFocusTarget()

UWidget * UModalMenuSystemWidget::NativeGetDesiredFocusTarget ( ) const

overridevirtual

{
    if(ModalData.Style == EMenuSystemModalType::Notification)
    {
        return Super::NativeGetDesiredFocusTarget();
    }
    return CloseButton;
}

NativeOnHandleBackAction()

bool UModalMenuSystemWidget::NativeOnHandleBackAction ( )

overridevirtual

Reimplemented from UMenuSystemWidget.

{
    OnButtonClicked(CloseButtonIndex);
    return Super::NativeOnHandleBackAction();
}

NativePreConstruct()

void UModalMenuSystemWidget::NativePreConstruct ( )

overrideprotectedvirtual

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

OnButtonClicked()

void UModalMenuSystemWidget::OnButtonClicked ( const int32 Index )

protected

{
    if(Index == CloseButtonIndex)
    {
        CloseWindow();
        OnCloseModal.Broadcast();
    }
    OnModalButtonSelected.Broadcast(Index);
}

PlayCloseAnimation()

void UModalMenuSystemWidget::PlayCloseAnimation

(

)

PlayOpenAnimation()

void UModalMenuSystemWidget::PlayOpenAnimation

(

)

PlaySound()

void UModalMenuSystemWidget::PlaySound ( USoundBase * Sound ) const

private

{
    if(GetOwningPlayer() != nullptr && Sound != nullptr)
    {
        UGameplayStatics::PlaySound2D(GetOwningPlayer(), Sound);
    }
}

SetModal()

void UModalMenuSystemWidget::SetModal ( )

private

{
    CreateExtraButtons();
    ApplySettings();
    UVerticalBoxSlot* DescriptionTextSlot = Cast<UVerticalBoxSlot>(DescriptionTextBlock->Slot);
    UVerticalBoxSlot* ButtonsBoxSlot = Cast<UVerticalBoxSlot>(ButtonHorizontalBox->Slot);
 
    if(ModalData.Style == EMenuSystemModalType::Notification)
    {
        ModalBorder->SetPadding(NotificationPadding);
        ExtraButtons->SetVisibility(ESlateVisibility::Collapsed);
        if(ButtonsBoxSlot != nullptr)
        {
            ButtonsBoxSlot->SetHorizontalAlignment(HAlign_Right);
        }
        if(DescriptionTextSlot != nullptr)
        {
            DescriptionTextSlot->SetPadding(FMargin(0.0f, NotificationPadding));
        }
        return;
    }
    if(DescriptionTextSlot != nullptr)
    {
        DescriptionTextSlot->SetPadding(FMargin(0.0f, BorderPadding));
    }
    if(ButtonsBoxSlot != nullptr)
    {
        ButtonsBoxSlot->SetHorizontalAlignment(HAlign_Center);
    }
    ModalBorder->SetPadding(BorderPadding);
}

SetValues() [1/2]

void UModalMenuSystemWidget::SetValues	(	const EMenuSystemModalAlert	Alert,
		const EMenuSystemModalType	Style,
		FString	Title,
		FString	Description,
		FString	LeftText,
		FString	RightText )

{
    ModalData.Alert = Alert;
    ModalData.Style = Style;
    ModalData.Title = Title;
    ModalData.Description = Description;
    ModalData.MainButtonText = LeftText;
    ModalData.CloseButtonText = RightText;
    // CloseButton->SetButtonFocus();
    ApplySettings();
}

SetValues() [2/2]

void UModalMenuSystemWidget::SetValues

(

const FModalData &

Data

)

{
    ModalData.Alert = Data.Alert;
    ModalData.Style = Data.Style;
    ModalData.Title = Data.Title;
    ModalData.Description = Data.Description;
    ModalData.MainButtonText = Data.MainButtonText;
    ModalData.CloseButtonText = Data.CloseButtonText;
    // CloseButton->SetButtonFocus();
    ApplySettings();
}

Member Data Documentation

BorderPadding

float UModalMenuSystemWidget::BorderPadding = 32.0f

protected

ButtonHorizontalBox

class UHorizontalBox* UModalMenuSystemWidget::ButtonHorizontalBox = nullptr

protected

CloseButton

class USelectionButtonMenuSystem* UModalMenuSystemWidget::CloseButton = nullptr

protected

CloseButtonIndex

int32 UModalMenuSystemWidget::CloseButtonIndex = 0

protected

ColorType

FLinearColor UModalMenuSystemWidget::ColorType

private

DefaultOpenSound

class USoundBase* UModalMenuSystemWidget::DefaultOpenSound = nullptr

protected

DescriptionTextBlock

class UTextBlock* UModalMenuSystemWidget::DescriptionTextBlock = nullptr

protected

ErrorColor

FLinearColor UModalMenuSystemWidget::ErrorColor

protected

ErrorSound

class USoundBase* UModalMenuSystemWidget::ErrorSound = nullptr

protected

ExtraButtons

class UStackBox* UModalMenuSystemWidget::ExtraButtons = nullptr

protected

GeneralColor

FLinearColor UModalMenuSystemWidget::GeneralColor

protected

HighlightColorBorder

class UBorder* UModalMenuSystemWidget::HighlightColorBorder = nullptr

protected

JustifyType

ETextJustify::Type UModalMenuSystemWidget::JustifyType = ETextJustify::Left

private

MainButton

class USelectionButtonMenuSystem* UModalMenuSystemWidget::MainButton = nullptr

protected

MainButtonContainer

class UHorizontalBox* UModalMenuSystemWidget::MainButtonContainer = nullptr

protected

MainButtonIndex

int32 UModalMenuSystemWidget::MainButtonIndex = 1

protected

MainVerticalBox

class UVerticalBox* UModalMenuSystemWidget::MainVerticalBox = nullptr

protected

ModalBorder

class UBorder* UModalMenuSystemWidget::ModalBorder = nullptr

protected

ModalData

FModalData UModalMenuSystemWidget::ModalData

NotificationLifetime

float UModalMenuSystemWidget::NotificationLifetime = 3.0f

protected

NotificationPadding

float UModalMenuSystemWidget::NotificationPadding = 5.0f

protected

NotificationSound

class USoundBase* UModalMenuSystemWidget::NotificationSound = nullptr

protected

NotificationTimerHandle

FTimerHandle UModalMenuSystemWidget::NotificationTimerHandle

private

OnCloseModal

FOnCloseModal UModalMenuSystemWidget::OnCloseModal

OnModalButtonSelected

FOnModalButtonSelected UModalMenuSystemWidget::OnModalButtonSelected

SelectionButtonClass

TSubclassOf<class UUserWidget> UModalMenuSystemWidget::SelectionButtonClass

private

SpacerSize

float UModalMenuSystemWidget::SpacerSize = 17.0f

protected

SystemColor

FLinearColor UModalMenuSystemWidget::SystemColor

protected

TitleTextBlock

class UTextBlock* UModalMenuSystemWidget::TitleTextBlock = nullptr

protected

WarningColor

FLinearColor UModalMenuSystemWidget::WarningColor

protected

WarningSound

class USoundBase* UModalMenuSystemWidget::WarningSound = 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/ModalMenuSystemWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Private/Widgets/ModalMenuSystemWidget.cpp