Navigation
API > API/Plugins > API/Plugins/PropertyAnimator
Format options used to convert a number to string
| Name | FPropertyAnimatorCounterFormat |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/PropertyAnimator/Source/PropertyAnimator/Public/Animators/PropertyAnimatorCounter.h |
| Include Path | #include "Animators/PropertyAnimatorCounter.h" |
Syntax
USTRUCT (BlueprintType )
struct FPropertyAnimatorCounterFormat
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Animators/PropertyAnimatorCounter.h | |||
FPropertyAnimatorCounterFormat
(
FName InFormatName |
Animators/PropertyAnimatorCounter.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bTruncate | bool | Truncate when the value exceeds the display format | Animators/PropertyAnimatorCounter.h |
|
| bUseSign | bool | Add a prefix symbol to show the sign of the number (+, -) | Animators/PropertyAnimatorCounter.h |
|
| DecimalCharacter | FString | Decimal separator character | Animators/PropertyAnimatorCounter.h |
|
| FormatName | FName | Format friendly name | Animators/PropertyAnimatorCounter.h |
|
| GroupingCharacter | FString | Thousands separator character | Animators/PropertyAnimatorCounter.h |
|
| GroupingSize | uint8 | Used to group numbers together like thousands | Animators/PropertyAnimatorCounter.h |
|
| MaxDecimalCount | uint8 | Maximum number of decimal precision after the decimal separator | Animators/PropertyAnimatorCounter.h |
|
| MinIntegerCount | uint8 | Minimum number of integer before the decimal separator for padding | Animators/PropertyAnimatorCounter.h |
|
| PaddingCharacter | FString | Filling character for leading blanks | Animators/PropertyAnimatorCounter.h |
|
| RoundingMode | EPropertyAnimatorCounterRoundingMode | Whether rounding the number is needed | Animators/PropertyAnimatorCounter.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnsureCharactersLength() |
Clamp custom characters to one char only | Animators/PropertyAnimatorCounter.h | |
FString FormatNumber
(
double InNumber |
Format a number using these options | Animators/PropertyAnimatorCounter.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FPropertyAnimatorCounterFormat& InOther |
Animators/PropertyAnimatorCounter.h | ||
bool operator==
(
const FPropertyAnimatorCounterFormat& InOther |
Animators/PropertyAnimatorCounter.h |