USelectionButtonMenuSystem Class Reference

#include <SelectionButtonMenuSystem.h>

Inheritance diagram for USelectionButtonMenuSystem:

Public Member Functions
virtual bool	Initialize () override
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override
virtual void	NativeOnAddedToFocusPath (const FFocusEvent &InFocusEvent) override
virtual void	NativeOnRemovedFromFocusPath (const FFocusEvent &InFocusEvent) override
virtual void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override
void	SetButtonText (FString Text) const
void	SetButtonFocus () const
bool	GetIsFocused () const
void	SetButtonIndex (const int32 Index)
int32	GetButtonIndex () const
void	SetTempDisabled (const bool bValue=true)
void	SetDisabled (const bool bValue=true)
bool	GetIsDisabled () const
void	PlaySelectionAnimation (bool bForward)
Public Member Functions inherited from UCommonWidgetBase
void	PlaySlateSound (const FSlateSound &SlateSound) const

Public Attributes
FOnSelectionButtonClicked	OnSelectionButtonClicked

Protected Attributes
class UButton *	MainButton = nullptr
class UTextBlock *	ButtonTextBlock = nullptr
class UButtonPromptWidget *	ButtonPrompt = nullptr
FName	SelectInputName = "Confirm"
FButtonStyle	MouseStyle
FButtonStyle	KeySelected
FButtonStyle	KeyNotSelected
bool	bDisabled = false
int32	ButtonIndex = 0
Protected Attributes inherited from UCommonWidgetBase
bool	bDebuggingMode = false

Private Member Functions
void	OnClicked ()

Additional Inherited Members
Protected Member Functions inherited from UCommonWidgetBase
virtual void	Setup ()
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)

Member Function Documentation

GetButtonIndex()

int32 USelectionButtonMenuSystem::GetButtonIndex ( ) const

inline

{return ButtonIndex;};

GetIsDisabled()

bool USelectionButtonMenuSystem::GetIsDisabled ( ) const

inline

{return bDisabled;};

GetIsFocused()

bool USelectionButtonMenuSystem::GetIsFocused ( ) const

inline

{return MainButton->HasAnyUserFocus();};

Initialize()

bool USelectionButtonMenuSystem::Initialize ( )

overridevirtual

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(MainButton != nullptr)) return false;
    if (!ensure(ButtonTextBlock != nullptr)) return false;
    if (!ensure(ButtonPrompt != nullptr)) return false;
    MainButton->OnClicked.AddDynamic(this, &USelectionButtonMenuSystem::OnClicked);
    return true;
}

NativeConstruct()

void USelectionButtonMenuSystem::NativeConstruct ( )

overridevirtual

Reimplemented from UCommonWidgetBase.

{
    Super::NativeConstruct();
    if(ButtonPrompt == nullptr || MainButton == nullptr){return;}
    MainButton->SetIsEnabled(!bDisabled);
    ButtonPrompt->SetHasProgress(false);
    ButtonPrompt->SetInputActionFromTable(SelectInputName);
}

NativeOnAddedToFocusPath()

void USelectionButtonMenuSystem::NativeOnAddedToFocusPath ( const FFocusEvent & InFocusEvent )

overridevirtual

{
    Super::NativeOnAddedToFocusPath(InFocusEvent);
    MainButton->SetStyle(KeySelected);
    PlaySelectionAnimation(true);
    ButtonPrompt->SetVisibility(ESlateVisibility::Visible);
    PlaySlateSound(MainButton->GetStyle().HoveredSlateSound);
}

NativeOnMouseEnter()

void USelectionButtonMenuSystem::NativeOnMouseEnter ( const FGeometry & InGeometry, const FPointerEvent & InMouseEvent )

overridevirtual

{
    Super::NativeOnMouseEnter(InGeometry, InMouseEvent);
    MainButton->SetStyle(MouseStyle);
    PlaySelectionAnimation(true);
}

NativeOnMouseLeave()

void USelectionButtonMenuSystem::NativeOnMouseLeave ( const FPointerEvent & InMouseEvent )

overridevirtual

{
    Super::NativeOnMouseLeave(InMouseEvent);
    MainButton->SetStyle(MouseStyle);
    PlaySelectionAnimation(false);
    ButtonPrompt->SetVisibility(ESlateVisibility::Hidden);
}

NativeOnRemovedFromFocusPath()

void USelectionButtonMenuSystem::NativeOnRemovedFromFocusPath ( const FFocusEvent & InFocusEvent )

overridevirtual

{
    Super::NativeOnRemovedFromFocusPath(InFocusEvent);
    MainButton->SetStyle(KeyNotSelected);
    PlaySelectionAnimation(false);
    ButtonPrompt->SetVisibility(ESlateVisibility::Hidden);
}

NativePreConstruct()

void USelectionButtonMenuSystem::NativePreConstruct ( )

overridevirtual

Reimplemented from UCommonWidgetBase.

{
    Super::NativePreConstruct();
    if(ButtonPrompt == nullptr || MainButton == nullptr){return;}
    MainButton->SetIsEnabled(!bDisabled);
    ButtonPrompt->SetHasProgress(false);
    ButtonPrompt->SetInputActionFromTable(SelectInputName);
}

OnClicked()

void USelectionButtonMenuSystem::OnClicked ( )

private

{
    if(!bDisabled)
    {
        OnSelectionButtonClicked.Broadcast(ButtonIndex);
    }
}

PlaySelectionAnimation()

void USelectionButtonMenuSystem::PlaySelectionAnimation

(

bool

bForward

)

SetButtonFocus()

void USelectionButtonMenuSystem::SetButtonFocus

(

)

const

{
    if(MainButton != nullptr)
    {
        if(GetOwningPlayer() != nullptr)
        {
            MainButton->SetUserFocus(GetOwningPlayer());
        }
        else
        {
            MainButton->SetKeyboardFocus();
            MainButton->SetFocus();
        }
    }
}

SetButtonIndex()

void USelectionButtonMenuSystem::SetButtonIndex ( const int32 Index )

inline

{ButtonIndex = Index;};

SetButtonText()

void USelectionButtonMenuSystem::SetButtonText

(

FString

Text

)

const

{
    if(ButtonTextBlock != nullptr)
    {
        ButtonTextBlock->SetText(FText::FromString(Text));
    }
}

SetDisabled()

void USelectionButtonMenuSystem::SetDisabled ( const bool bValue = true )

inline

{bDisabled = bValue;};

SetTempDisabled()

void USelectionButtonMenuSystem::SetTempDisabled

(

const bool

bValue = true

)

{
    if(bValue)
    {
        MainButton->SetIsEnabled(!bValue);
    }
    else
    {
        MainButton->SetIsEnabled(!bDisabled);
    }
}

Member Data Documentation

bDisabled

bool USelectionButtonMenuSystem::bDisabled = false

protected

ButtonIndex

int32 USelectionButtonMenuSystem::ButtonIndex = 0

protected

ButtonPrompt

class UButtonPromptWidget* USelectionButtonMenuSystem::ButtonPrompt = nullptr

protected

ButtonTextBlock

class UTextBlock* USelectionButtonMenuSystem::ButtonTextBlock = nullptr

protected

KeyNotSelected

FButtonStyle USelectionButtonMenuSystem::KeyNotSelected

protected

KeySelected

FButtonStyle USelectionButtonMenuSystem::KeySelected

protected

MainButton

class UButton* USelectionButtonMenuSystem::MainButton = nullptr

protected

MouseStyle

FButtonStyle USelectionButtonMenuSystem::MouseStyle

protected

OnSelectionButtonClicked

FOnSelectionButtonClicked USelectionButtonMenuSystem::OnSelectionButtonClicked

SelectInputName

FName USelectionButtonMenuSystem::SelectInputName = "Confirm"

protected

---

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

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