UButtonPromptWidget Class Reference

User widget representing a button prompt for It provides functionality for displaying a button icon, a progress bar, and handling button events. More...

#include <ButtonPromptWidget.h>

Inheritance diagram for UButtonPromptWidget:

Public Member Functions
	UButtonPromptWidget (const FObjectInitializer &ObjectInitializer)
void	StartButtonProgress (const float Time)
void	ButtonProgress ()
void	StopButtonProgress ()
float	GetButtonProgress () const
void	SetAvailable (const bool bValue=true)
void	SetHasProgress (const bool bValue)
bool	GetHasProgress () const
void	SetInputAction (UInputAction *Action)
void	SetInputActionFromTable (const FName &Name)
void	SetShowText (const bool bValue)
void	SetSizeValue (const float Value)
void	SetSize (const ESize Value)

Public Attributes
FOnButtonPressed	OnButtonPressed
class UMaterialInstance *	ProgressBar = nullptr
float	Progress = 0.0f
float	ProgressTickTime = 0.01f
float	ProgressIncrementRate = 1.0f
bool	bUseInputAction = false
bool	bUseDataTable = false
bool	bShowText = false
bool	bKeepProgressSize = false

Protected Member Functions
virtual bool	Initialize () override
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override

Protected Attributes
bool	bHasProgressBar = false
float	SizeValue = 52.0f
ESize	Size = ESize::Medium
float	DefaultSize = 52.0f
UInputAction *	InputAction = nullptr
class UDataTable *	InputActionDT
FDataTableRowHandle	InputActionRow
class UCommonActionWidget *	ButtonIconAction = nullptr
class UImage *	ProgressBarImage = nullptr
class UTextBlock *	PromptText = nullptr
class USizeBox *	SizeContainer = nullptr
bool	bAvailable = true
UMaterialInstanceDynamic *	DynamicMaterial = nullptr

Private Member Functions
void	SetProgressBarMaterial ()

Private Attributes
FTimerHandle	ProgressTimerHandle

Detailed Description

User widget representing a button prompt for It provides functionality for displaying a button icon, a progress bar, and handling button events.

The button prompt widget can be set to be available or unavailable, depending on the state of the When the button is pressed, the OnButtonPressed event is broadcasted.

Note

This class requires the API (BaseHelpers) to be defined in order to be used as an API class.

See also

UUserWidget

Note

FINISHED

Constructor & Destructor Documentation

UButtonPromptWidget()

UButtonPromptWidget::UButtonPromptWidget ( const FObjectInitializer & ObjectInitializer )

explicit

    :Super(ObjectInitializer)
{
    InputActionDT = LoadObject<UDataTable>(nullptr, TEXT("/CommonUIStyle/Data/DT_InputAction"));
    if(InputActionDT != nullptr)
    {
        InputActionRow.DataTable = InputActionDT;
    }
}

Member Function Documentation

ButtonProgress()

void UButtonPromptWidget::ButtonProgress

(

)

GetButtonProgress()

float UButtonPromptWidget::GetButtonProgress ( ) const

inline

{return Progress;};

GetHasProgress()

bool UButtonPromptWidget::GetHasProgress ( ) const

inline

{return bHasProgressBar;};

Initialize()

bool UButtonPromptWidget::Initialize ( )

overrideprotectedvirtual

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(ProgressBarImage != nullptr)) return false;
    if (!ensure(ButtonIconAction != nullptr)) return false;
    if (!ensure(SizeContainer != nullptr)) return false;
    if (!ensure(PromptText != nullptr)) return false;
    return true;
}

NativeConstruct()

void UButtonPromptWidget::NativeConstruct ( )

overrideprotectedvirtual

{
    Super::NativeConstruct();
    SetProgressBarMaterial();
    if(bUseInputAction)
    {
        SetInputAction(InputAction);
    }
    if(bUseDataTable)
    {
        SetInputActionFromTable(InputActionRow.RowName);
    }
    SetShowText(bShowText);
    SetSize(Size);
}

NativePreConstruct()

void UButtonPromptWidget::NativePreConstruct ( )

overrideprotectedvirtual

{
    Super::NativePreConstruct();
    SetProgressBarMaterial();
    if(bUseInputAction)
    {
        SetInputAction(InputAction);
    }
    if(bUseDataTable)
    {
        SetInputActionFromTable(InputActionRow.RowName);
    }
    SetShowText(bShowText);
    SetSize(Size);
}

SetAvailable()

void UButtonPromptWidget::SetAvailable

(

const bool

bValue = true

)

{
    bAvailable = bValue;
}

SetHasProgress()

void UButtonPromptWidget::SetHasProgress

(

const bool

bValue

)

{
    bHasProgressBar = bValue;
    SetProgressBarMaterial();
}

SetInputAction()

void UButtonPromptWidget::SetInputAction

(

UInputAction *

Action

)

{
    if(Action == nullptr)
    {
        return;
    }
    if(ButtonIconAction == nullptr){return;}
    InputAction = Action;
    if(InputAction != nullptr)
    {
        ButtonIconAction->SetEnhancedInputAction(InputAction);
    }
}

SetInputActionFromTable()

void UButtonPromptWidget::SetInputActionFromTable

(

const FName &

Name

)

{
    if(ButtonIconAction == nullptr){return;}
    if(InputActionDT != nullptr)
    {
        InputActionRow.DataTable = InputActionDT;
        InputActionRow.RowName = Name;
        if(InputActionRow.IsNull()){return;}
        ButtonIconAction->SetInputAction(InputActionRow);
    }
}

SetProgressBarMaterial()

void UButtonPromptWidget::SetProgressBarMaterial ( )

private

{
    if(ProgressBarImage != nullptr)
    {
        if(bHasProgressBar && ProgressBar != nullptr)
        {
            DynamicMaterial = UKismetMaterialLibrary::CreateDynamicMaterialInstance(GetWorld(), ProgressBar);
            if(DynamicMaterial == nullptr){return;}
            ProgressBarImage->SetVisibility(ESlateVisibility::Visible);
            ProgressBarImage->SetBrushFromMaterial(DynamicMaterial);
        }
        else
        {
            if(bKeepProgressSize)
            {
                ProgressBarImage->SetVisibility(ESlateVisibility::Hidden);
            }
            else
            {
                ProgressBarImage->SetVisibility(ESlateVisibility::Collapsed);
            }
        }
    }
}

SetShowText()

void UButtonPromptWidget::SetShowText

(

const bool

bValue

)

{
    bShowText = bValue;
    if(PromptText == nullptr){return;}
    if(ButtonIconAction != nullptr)
    {
        PromptText->SetText(ButtonIconAction->GetDisplayText());
    }
    if(bShowText)
    {
        PromptText->SetVisibility(ESlateVisibility::Visible);
    }
    else
    {
        PromptText->SetVisibility(ESlateVisibility::Collapsed);
    }
}

SetSize()

void UButtonPromptWidget::SetSize

(

const ESize

Value

)

{
    // float Multiplier = 1.0f;
    Size = Value;
    switch (Size) {
    case ESize::ExtraSmall:
        SetSizeValue(DefaultSize / 1.75f); // 29
        break;
    case ESize::Small:
        SetSizeValue(DefaultSize / 1.5f); // 34
        break;
    case ESize::SmallMedium:
        SetSizeValue(DefaultSize / 1.25f); // 41
        break;
    case ESize::Medium:
        SetSizeValue(DefaultSize); // 52
        break;
    case ESize::MediumLarge:
        SetSizeValue(DefaultSize * 1.25f); // 65
        break;
    case ESize::Large:
        SetSizeValue(DefaultSize * 1.5f); // 78
        break;
    case ESize::ExtraLarge:
        SetSizeValue(DefaultSize * 1.75); // 91
        break;
    }
    // SetSizeValue(DefaultSize * Multiplier);
}

SetSizeValue()

void UButtonPromptWidget::SetSizeValue

(

const float

Value

)

{
    SizeValue = Value;
    if(SizeContainer == nullptr){return;}
    SizeContainer->SetHeightOverride(Value);
    SizeContainer->SetWidthOverride(Value);
}

StartButtonProgress()

void UButtonPromptWidget::StartButtonProgress

(

const float

Time

)

StopButtonProgress()

void UButtonPromptWidget::StopButtonProgress

(

)

Member Data Documentation

bAvailable

bool UButtonPromptWidget::bAvailable = true

protected

bHasProgressBar

bool UButtonPromptWidget::bHasProgressBar = false

protected

bKeepProgressSize

bool UButtonPromptWidget::bKeepProgressSize = false

bShowText

bool UButtonPromptWidget::bShowText = false

bUseDataTable

bool UButtonPromptWidget::bUseDataTable = false

bUseInputAction

bool UButtonPromptWidget::bUseInputAction = false

ButtonIconAction

class UCommonActionWidget* UButtonPromptWidget::ButtonIconAction = nullptr

protected

DefaultSize

float UButtonPromptWidget::DefaultSize = 52.0f

protected

DynamicMaterial

UMaterialInstanceDynamic* UButtonPromptWidget::DynamicMaterial = nullptr

protected

InputAction

UInputAction* UButtonPromptWidget::InputAction = nullptr

protected

InputActionDT

class UDataTable* UButtonPromptWidget::InputActionDT

protected

InputActionRow

FDataTableRowHandle UButtonPromptWidget::InputActionRow

protected

OnButtonPressed

FOnButtonPressed UButtonPromptWidget::OnButtonPressed

Progress

float UButtonPromptWidget::Progress = 0.0f

ProgressBar

class UMaterialInstance* UButtonPromptWidget::ProgressBar = nullptr

ProgressBarImage

class UImage* UButtonPromptWidget::ProgressBarImage = nullptr

protected

ProgressIncrementRate

float UButtonPromptWidget::ProgressIncrementRate = 1.0f

ProgressTickTime

float UButtonPromptWidget::ProgressTickTime = 0.01f

ProgressTimerHandle

FTimerHandle UButtonPromptWidget::ProgressTimerHandle

private

PromptText

class UTextBlock* UButtonPromptWidget::PromptText = nullptr

protected

Size

ESize UButtonPromptWidget::Size = ESize::Medium

protected

SizeContainer

class USizeBox* UButtonPromptWidget::SizeContainer = nullptr

protected

SizeValue

float UButtonPromptWidget::SizeValue = 52.0f

protected

---

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

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