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

UCommonNumericTextBlock

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UTextLayoutWidget

UTextBlock

UCommonTextBlock

UCommonNumericTextBlock

References

Module	CommonUI
Header	/Engine/Plugins/Experimental/CommonUI/Source/CommonUI/Public/CommonNumericTextBlock.h
Include	#include "CommonNumericTextBlock.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UCommonNumericTextBlock : public UCommonTextBlock

Variables

	Name	Description
float	CurrentNumericValue	The current numeric value being formatted for display, potentially being interpolated from.
float	DestinationValue
float	Duration
float	EaseOutInterpolationExponent	Exponent parameter for the "ease out" interpolation curve.
float	ElapsedStateDuration
FCommonNumberFo...	FormattingSpecification	The specifications for how the current numeric value should be formatted in to numeral text.
bool	HasTriggeredOutro
int32	InitialWidth
float	InterpolationUpdateInterval	The desired interval, in seconds, between interpolation updates.
ECommonNumericT...	NumericType
FOnInterpolatio...	OnInterpolationEndedEvent	Event triggered when interpolation has ended.
FOnInterpolatio...	OnInterpolationStartedEvent	Event triggered when interpolation has started.
FOnInterpolatio...	OnInterpolationUpdatedEvent	Event triggered when interpolation has updated.
FOnOutro	OnOutroEvent	Event triggered at a specified time before the interpolation completes, for "outro" purposes.
float	OutroOffset
bool	PerformSizeInterpolation
float	PostInterpolationShrinkDuration	The desired width of the formatted text may change rapidly and erratically during interpolation due to font glyph dimensions.
float	SourceValue

Constructors

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

Functions

	Name	Description
FText	FormatText ( float InCurrentNumericValue, const FNumberFormattingOptions& In... )
float	GetTargetValue()	Returns the value this widget will ultimately show if it is interpolating, or the current value if it is not.
void	InterpolateToValue ( const float TargetValue, float MaximumInterpolationDuration, float MinimumChangeRate, float OutroOffset )	Starts an ongoing process of interpolating the current numeric value to the specified target value.
bool	IsInterpolatingNumericValue()
void	SetCurrentValue ( const float NewValue )	Sets the current numeric value.
void	SetNumericType ( ECommonNumericType InNumericType )
void	UpdateUnderlyingText()

Overridden from UWidget

		Name	Description
	const FText	GetPaletteCategory()	Gets the palette category of the widget
	void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

Enums

	Name	Description
	EInterpolationState	Enum for interpolation state machine.

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

Take our survey

Dismiss