Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UProgressBar

The progress bar widget is a simple bar that fills up that can be restyled to fit any number of uses.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UProgressBar

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/ProgressBar.h
Include	#include "Components/ProgressBar.h"

Syntax

class UProgressBar : public UWidget

Remarks

The progress bar widget is a simple bar that fills up that can be restyled to fit any number of uses.

No Children

Variables

	Name	Description
TEnumAsByte< EP...	BarFillType	Defines if this progress bar fills Left to right or right to left
bool	bIsMarquee
FVector2D	BorderPadding
FLinearColor	FillColorAndOpacity	Fill Color and Opacity
FGetLinearColor	FillColorAndOpacityDelegate
FSlateColor	K2_Cache_FillColorAndOpacity
TSharedPtr< SPr...	MyProgressBar	Native Slate Widget
float	Percent	Used to determine the fill position of the progress bar ranging 0..1
FGetFloat	PercentDelegate	A bindable delegate to allow logic to drive the text of the widget
FProgressBarSty...	WidgetStyle	The progress bar style

Constructors

	Name	Description
	UProgressBar ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FSlateColor	K2_Gate_FillColorAndOpacity()
void	SetFillColorAndOpacity ( FLinearColor InColor )	Sets the fill color of the progress bar.
void	SetIsMarquee ( bool InbIsMarquee )	Sets the progress bar to show as a marquee.
void	SetPercent ( float InPercent )	Sets the current value of the ProgressBar.

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnCreationFromPalette()	Called by the palette after constructing a new widget, allows the widget to perform interesting default setup that we don't want to be UObject Defaults.
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

	Name	Description
USlateBrushAsse...	BackgroundImage_DEPRECATED	The brush to use as the background of the progress bar
USlateBrushAsse...	FillImage_DEPRECATED	The brush to use as the fill image
USlateBrushAsse...	MarqueeImage_DEPRECATED	The brush to use as the marquee image
USlateWidgetSty...	Style_DEPRECATED	Style used for the progress bar

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss