1. Epic GamesDeveloper
  3. UCommonNumericTextBlock

UCommonNumericTextBlock

Numeric text block that provides interpolation, and some type support (numbers, percents, seconds, distance).

API > API/Plugins > API/Plugins/CommonUI

Numeric text block that provides interpolation, and some type support (numbers, percents, seconds, distance).

   
Name UCommonNumericTextBlock
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonNumericTextBlock.h
Include Path #include "CommonNumericTextBlock.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UCommonNumericTextBlock : public UCommonTextBlock

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonNumericTextBlock ( const FObjectInitializer& ObjectInitializer
)

   CommonNumericTextBlock.h  

Classes

Name Remarks
FOnInterpolationEnded  
FOnInterpolationStarted  
FOnInterpolationUpdated  
FOnOutro  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CurrentNumericValue float The current numeric value being formatted for display, potentially being interpolated from. NOTE: The displayed text is very likely not identical to this value, due to formatting. CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Numeric Text Block"
DestinationValue float   CommonNumericTextBlock.h  
Duration float   CommonNumericTextBlock.h  
EaseOutInterpolationExponent float Exponent parameter for the "ease out" interpolation curve. CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Numeric Interpolation"
  • Meta=(ClampMin="1.0")
ElapsedStateDuration float   CommonNumericTextBlock.h  
FormattingSpecification FCommonNumberFormattingOptions The specifications for how the current numeric value should be formatted in to numeral text. CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Numeral Formatting"
HasTriggeredOutro bool   CommonNumericTextBlock.h  
InitialWidth int32   CommonNumericTextBlock.h  
InterpolationUpdateInterval float The desired interval, in seconds, between interpolation updates. CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Numeric Interpolation"
  • Meta=(ClampMin="0.0")
NumericType ECommonNumericType   CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Numeral Formating"
OnInterpolationEndedEvent FOnInterpolationEnded Event triggered when interpolation has ended. CommonNumericTextBlock.h
  • BlueprintAssignable
  • Category="Numeric Interpolation"
OnInterpolationStartedEvent FOnInterpolationStarted Event triggered when interpolation has started. CommonNumericTextBlock.h
  • BlueprintAssignable
  • Category="Numeric Interpolation"
OnInterpolationUpdatedEvent FOnInterpolationUpdated Event triggered when interpolation has updated. CommonNumericTextBlock.h
  • BlueprintAssignable
  • Category="Numeric Interpolation"
OnOutroEvent FOnOutro Event triggered at a specified time before the interpolation completes, for "outro" purposes. CommonNumericTextBlock.h
  • BlueprintAssignable
  • Category="Numeric Interpolation"
OutroOffset float   CommonNumericTextBlock.h  
PerformSizeInterpolation bool   CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Size Interpolation"
PostInterpolationShrinkDuration float The desired width of the formatted text may change rapidly and erratically during interpolation due to font glyph dimensions. CommonNumericTextBlock.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Size Interpolation"
  • Meta=(ClampMin="0.0")
SourceValue float   CommonNumericTextBlock.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentInterpolationState enum UCommonNumericTextBlock::EInterpolationState   CommonNumericTextBlock.h  
InterpolationState UCommonNumericTextBlock State data for any current interpolation state. CommonNumericTextBlock.h  
LastTimerTickTime float   CommonNumericTextBlock.h  
NumericInterpolationState UCommonNumericTextBlock State data exclusively used when interpolating the numeric values. CommonNumericTextBlock.h  
SizeInterpolationState UCommonNumericTextBlock State data exclusively used when interpolating the minimum desired width to shrink after completing numeric interpolation. CommonNumericTextBlock.h  
TimerTickHandle FTimerHandle Timer handle for timer-based ticking based on InterpolationUpdateInterval. CommonNumericTextBlock.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetTargetValue()

 Returns the value this widget will ultimately show if it is interpolating, or the current value if it is not. CommonNumericTextBlock.h
  • BlueprintCallable
  • Category="Numeric Text Block"

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. CommonNumericTextBlock.h
  • BlueprintCallable
  • Category="Numeric Interpolation"

bool IsInterpolatingNumericValue()

   CommonNumericTextBlock.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Numeric Interpolation"

void SetCurrentValue ( const float NewValue
)

 Sets the current numeric value. NOTE: Cancels any ongoing interpolation! CommonNumericTextBlock.h
  • BlueprintCallable
  • Category="Numeric Text Block"

void SetNumericType ( ECommonNumericType InNumericType
)

   CommonNumericTextBlock.h
  • BlueprintCallable
  • Category="Numeral Formating"

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

   CommonNumericTextBlock.h  

virtual void SynchronizeProperties()

   CommonNumericTextBlock.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   CommonNumericTextBlock.h  

virtual void PostLoad()

   CommonNumericTextBlock.h  

virtual void Serialize ( FArchive& Ar
)

   CommonNumericTextBlock.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual FText FormatText ( float InCurrentNumericValue,
const FNumberFormattingOptions& InNumberFormattingOptions
) const

   CommonNumericTextBlock.h  

void UpdateUnderlyingText()

   CommonNumericTextBlock.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page