unreal.CommonNumberFormattingOptions

class unreal.CommonNumberFormattingOptions(rounding_mode=RoundingMode.HALF_FROM_ZERO, use_grouping=True, minimum_integral_digits=1, maximum_integral_digits=324, minimum_fractional_digits=0, maximum_fractional_digits=0)

Bases: unreal.StructBase

Common Number Formatting Options

C++ Source:

• Plugin: CommonUI

• Module: CommonUI

• File: CommonNumericTextBlock.h

Editor Properties: (see get_editor_property/set_editor_property)

• maximum_fractional_digits (int32): [Read-Write] Maximum Fractional Digits: How many fractional digits should be shown at maximum? May cause rounding. IE: HalfFromZero rounding and a maximum of 2 fractional digits means 0.009 -> “0.01”.

• maximum_integral_digits (int32): [Read-Write] Maximum Integral Digits: How many integral digits should be shown at maximum? May cause rounding. IE: A maximum of 2 integral digits means 100.0 -> “99”.

• minimum_fractional_digits (int32): [Read-Write] Minimum Fractional Digits: How many fractional digits should be shown at minimum? May cause digit “padding”. IE: A minimum of 2 fractional digits means 1.0 -> “1.00”.

• minimum_integral_digits (int32): [Read-Write] Minimum Integral Digits: How many integral digits should be shown at minimum? May cause digit “padding”. IE: A minimum of 3 integral digits means 1.0 -> “001”.

• rounding_mode (RoundingMode): [Read-Write] Rounding Mode: The rounding mode to be used when the actual value can not be precisely represented due to restrictions on the number of integral or fractional digits. See values for details.

• use_grouping (bool): [Read-Write] Use Grouping: Should the numerals use group separators. IE: “1,000,000”

property maximum_fractional_digits

[Read-Only] Maximum Fractional Digits: How many fractional digits should be shown at maximum? May cause rounding. IE: HalfFromZero rounding and a maximum of 2 fractional digits means 0.009 -> “0.01”.

Type

(int32)

property maximum_integral_digits

[Read-Only] Maximum Integral Digits: How many integral digits should be shown at maximum? May cause rounding. IE: A maximum of 2 integral digits means 100.0 -> “99”.

Type

(int32)

property minimum_fractional_digits

[Read-Only] Minimum Fractional Digits: How many fractional digits should be shown at minimum? May cause digit “padding”. IE: A minimum of 2 fractional digits means 1.0 -> “1.00”.

Type

(int32)

property minimum_integral_digits

[Read-Only] Minimum Integral Digits: How many integral digits should be shown at minimum? May cause digit “padding”. IE: A minimum of 3 integral digits means 1.0 -> “001”.

Type

(int32)

property rounding_mode

[Read-Only] Rounding Mode: The rounding mode to be used when the actual value can not be precisely represented due to restrictions on the number of integral or fractional digits. See values for details.

Type

(RoundingMode)

property use_grouping

[Read-Only] Use Grouping: Should the numerals use group separators. IE: “1,000,000”

Type

(bool)