unreal.CommonNumericTextBlock

class unreal.CommonNumericTextBlock(outer: Object | None = None, name: Name | str = 'None')

Bases: CommonTextBlock

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

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonNumericTextBlock.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • apply_line_height_to_bottom_line (bool): [Read-Write] Whether to leave extra space below the last line due to line height.

  • auto_collapse_with_empty_text (bool): [Read-Write] True to automatically collapse this text block when set to display an empty string. Conversely, will be SelfHitTestInvisible when showing a non-empty string.

  • auto_wrap_text (bool): [Read-Write] True if we’re wrapping text automatically based on the computed horizontal space for this widget.

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • color_and_opacity (SlateColor): [Read-Write] The color of the text

  • current_numeric_value (float): [Read-Write] 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.

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • display_all_caps (bool): [Read-Write] True to always display text in ALL CAPS deprecated: bDisplayAllCaps is deprecated. Please use TextTransformPolicy instead.

  • ease_out_interpolation_exponent (float): [Read-Write] Exponent parameter for the “ease out” interpolation curve. Must be > 0, but should be > 1 in order to “ease out”.

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • font (SlateFontInfo): [Read-Write] The font to render the text with

  • formatting_specification (CommonNumberFormattingOptions): [Read-Write] The specifications for how the current numeric value should be formatted in to numeral text.

  • interpolation_update_interval (float): [Read-Write] The desired interval, in seconds, between interpolation updates. 0.0 implies per-frame updates. NOTE: Interpolation updates may occur further apart due to tick rates.

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_scrolling_enabled (bool): [Read-Write] If scrolling is enabled/disabled initially, this can be updated in blueprint

  • is_volatile (bool): [Read-Write] If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • justification (TextJustify): [Read-Write] How the text should be aligned with the margin.

  • line_height_percentage (float): [Read-Write] The amount to scale each lines height by.

  • margin (Margin): [Read-Write] The amount of blank space left around the edges of text area.

  • min_desired_width (float): [Read-Write] The minimum desired size for the text

  • mobile_font_size_multiplier (float): [Read-Write] Mobile font size multiplier. Activated by default on mobile. See CVar Mobile_PreviewFontSize

  • navigation (WidgetNavigation): [Read-Write] The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • numeric_type (CommonNumericType): [Read-Write]

  • on_interpolation_ended_event (OnInterpolationEnded): [Read-Write] Event triggered when interpolation has ended.

  • on_interpolation_started_event (OnInterpolationStarted): [Read-Write] Event triggered when interpolation has started.

  • on_interpolation_updated_event (OnInterpolationUpdated): [Read-Write] Event triggered when interpolation has updated.

  • on_outro_event (OnOutro): [Read-Write] Event triggered at a specified time before the interpolation completes, for “outro” purposes.

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • perform_size_interpolation (bool): [Read-Write]

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

  • post_interpolation_shrink_duration (float): [Read-Write] The desired width of the formatted text may change rapidly and erratically during interpolation due to font glyph dimensions. To combat this, the desired width of the text will never shrink during interpolation. Once interpolation completes, the desired width will shrink over the duration specified.

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • scroll_style (type(Class)): [Read-Write] References the scroll style asset to use, no reference disables scrolling

  • shadow_color_and_opacity (LinearColor): [Read-Write] The color of the shadow

  • shadow_offset (Vector2D): [Read-Write] The direction the shadow is cast

  • shaped_text_options (ShapedTextOptions): [Read-Write] Controls how the text within this widget should be shaped.

  • simple_text_mode (bool): [Read-Write] If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement. This feature is only suitable for “simple” text (ie, text containing only numbers or basic ASCII) as it disables the complex text rendering support required for certain languages (such as Arabic and Thai). It is significantly faster for text that can take advantage of it (particularly if that text changes frequently), but shouldn’t be used for localized user-facing text.

  • slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • strike_brush (SlateBrush): [Read-Write] The brush to strike through text with

  • style (type(Class)): [Read-Write] References the text style to use

  • text (Text): [Read-Write] The text to display

  • text_overflow_policy (TextOverflowPolicy): [Read-Write] Sets what happens to text that is clipped and doesn’t fit within the clip rect for this widget

  • text_transform_policy (TextTransformPolicy): [Read-Write] The text transformation policy to apply to this text block.

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

  • wrap_text_at (float): [Read-Write] Whether text wraps onto a new line when it’s length exceeds this width; if this value is zero or negative, no wrapping occurs.

  • wrap_with_invalidation_panel (bool): [Read-Write] If true, it will automatically wrap this text widget with an invalidation panel

  • wrapping_policy (TextWrappingPolicy): [Read-Write] The wrapping policy to use.

property current_numeric_value: float

The displayed text is very likely not identical to this value, due to formatting.

Type:

(float)

Type:

[Read-Only] The current numeric value being formatted for display, potentially being interpolated from. NOTE

property ease_out_interpolation_exponent: float

[Read-Only] Exponent parameter for the “ease out” interpolation curve. Must be > 0, but should be > 1 in order to “ease out”.

Type:

(float)

property formatting_specification: CommonNumberFormattingOptions

[Read-Only] The specifications for how the current numeric value should be formatted in to numeral text.

Type:

(CommonNumberFormattingOptions)

get_target_value() → float

Returns the value this widget will ultimately show if it is interpolating, or the current value if it is not.

Return type:

float

interpolate_to_value(target_value, maximum_interpolation_duration=3.000000, minimum_change_rate=1.000000, outro_offset=0.000000) → None

Starts an ongoing process of interpolating the current numeric value to the specified target value. The interpolation process may take the specified maximum duration or complete sooner if the minimum change rate causes the target to be reached prematurely. Optionally, an outro duration can be specified in order to trigger an outro event before interpolation completes.

TargetValue The value to be interpolated to. MaximumInterpolationDuration The duration, in seconds, for the interpolation to take, at most. Must be greater than 0. MinimumChangeRate The minimum change in numeric value per second. Must be greater than or equal to 0. OutroDuration The time offset, in seconds, before the end of the InterpolationDuration elapses, at which to trigger an outro event. Must be less than or equal to MaximumInterpolationDuration

Parameters:

  • target_value (float) –

  • maximum_interpolation_duration (float) –

  • minimum_change_rate (float) –

  • outro_offset (float) –

property interpolation_update_interval: float

Interpolation updates may occur further apart due to tick rates.

Type:

(float)

Type:

[Read-Only] The desired interval, in seconds, between interpolation updates. 0.0 implies per-frame updates. NOTE

is_interpolating_numeric_value() → bool

Is Interpolating Numeric Value

Return type:

bool

property numeric_type: CommonNumericType

[Read-Only]

Type:

(CommonNumericType)

property on_interpolation_ended_event: OnInterpolationEnded

[Read-Write] Event triggered when interpolation has ended.

Type:

(OnInterpolationEnded)

property on_interpolation_started_event: OnInterpolationStarted

[Read-Write] Event triggered when interpolation has started.

Type:

(OnInterpolationStarted)

property on_interpolation_updated_event: OnInterpolationUpdated

[Read-Write] Event triggered when interpolation has updated.

Type:

(OnInterpolationUpdated)

property on_outro_event: OnOutro

[Read-Write] Event triggered at a specified time before the interpolation completes, for “outro” purposes.

Type:

(OnOutro)

property perform_size_interpolation: bool

[Read-Only]

Type:

(bool)

property post_interpolation_shrink_duration: float

[Read-Only] The desired width of the formatted text may change rapidly and erratically during interpolation due to font glyph dimensions. To combat this, the desired width of the text will never shrink during interpolation. Once interpolation completes, the desired width will shrink over the duration specified.

Type:

(float)

set_current_value(new_value) → None

Sets the current numeric value. NOTE: Cancels any ongoing interpolation!

Parameters:

new_value (float) –

set_numeric_type(numeric_type) → None

Set Numeric Type

Parameters:

numeric_type (CommonNumericType) –