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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType&41;  
class UCommonNumericTextBlock : public UCommonTextBlock

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float CurrentNumericValue 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.
Public variable float DestinationValue  
Public variable float Duration  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float EaseOutInterpolationExponent Exponent parameter for the "ease out" interpolation curve.
Public variable float ElapsedStateDuration  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FCommonNumberFormattingOptions FormattingSpecification The specifications for how the current numeric value should be formatted in to numeral text.
Public variable bool HasTriggeredOutro  
Public variable int32 InitialWidth  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float InterpolationUpdateInterval The desired interval, in seconds, between interpolation updates.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly ECommonNumericType NumericType  
Public variable UProperty Category BlueprintAssignable FOnInterpolationEnded OnInterpolationEndedEvent Event triggered when interpolation has ended.
Public variable UProperty Category BlueprintAssignable FOnInterpolationStarted OnInterpolationStartedEvent Event triggered when interpolation has started.
Public variable UProperty Category BlueprintAssignable FOnInterpolationUpdated OnInterpolationUpdatedEvent Event triggered when interpolation has updated.
Public variable UProperty Category BlueprintAssignable FOnOutro OnOutroEvent Event triggered at a specified time before the interpolation completes, for "outro" purposes.
Public variable float OutroOffset  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool PerformSizeInterpolation  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float PostInterpolationShrinkDuration The desired width of the formatted text may change rapidly and erratically during interpolation due to font glyph dimensions.
Public variable float SourceValue  

Constructors

  Type Name Description
Public function  

UCommonNumericTextBlock ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Virtual Const FText

FormatText ( float InCurrentNumericValue,
const FNumberFormattingOptions& InNumberFormattingOptions
)

  
Public function Const UFunction BlueprintCallable, Category float Returns the value this widget will ultimately show if it is interpolating, or the current value if it is not.
Public function UFunction BlueprintCallable, Category 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.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool  
Public function UFunction BlueprintCallable, Category void

SetCurrentValue ( const float NewValue
)

 Sets the current numeric value. NOTE: Cancels any ongoing interpolation!
Public function UFunction BlueprintCallable, Category void  
Protected function void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnInterpolationEnded    
Public class FOnInterpolationStarted    
Public class FOnInterpolationUpdated    
Public class FOnOutro    

Enums

  Type Name Description
Private enum EInterpolationState Enum for interpolation state machine.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page