unreal.TextBlock

class unreal.TextBlock(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: TextLayoutWidget

A simple static text widget.

  • No Children

  • Text

C++ Source:

  • Module: UMG

  • File: TextBlock.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Accessible Behavior: 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] Accessible Summary Behavior: 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] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

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

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

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

  • clipping (WidgetClipping): [Read-Write] Clipping

  • color_and_opacity (SlateColor): [Read-Write] Color and Opacity

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • font (SlateFontInfo): [Read-Write] Font

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_volatile (bool): [Read-Write] Is Volatile: 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] Justification: How the text should be aligned with the margin.

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

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

  • min_desired_width (float): [Read-Write] Min Desired Width

  • navigation (WidgetNavigation): [Read-Write] Navigation: 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.

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

  • override_cursor (bool): [Read-Write] Override Cursor

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • shadow_color_and_opacity (LinearColor): [Read-Write] Shadow Color and Opacity

  • shadow_offset (Vector2D): [Read-Write] Shadow Offset

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

  • simple_text_mode (bool): [Read-Write] Simple Text Mode: 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] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • strike_brush (SlateBrush): [Read-Write] Strike Brush

  • text (Text): [Read-Write] Text

  • text_overflow_policy (TextOverflowPolicy): [Read-Write] Text Overflow Policy

  • text_transform_policy (TextTransformPolicy): [Read-Write] Text Transform Policy

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • visibility (SlateVisibility): [Read-Write] Visibility

  • wrap_text_at (float): [Read-Write] Wrap Text At: 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] Wrap with Invalidation Panel: If true, it will automatically wrap this text widget with an invalidation panel

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

property color_and_opacity: SlateColor

[Read-Write] Color and Opacity

Type:

(SlateColor)

property font: SlateFontInfo

[Read-Write] Font

Type:

(SlateFontInfo)

get_dynamic_font_material() → MaterialInstanceDynamic

Get Dynamic Font Material

Return type:

MaterialInstanceDynamic

get_dynamic_outline_material() → MaterialInstanceDynamic

Get Dynamic Outline Material

Return type:

MaterialInstanceDynamic

get_text() → Text

Gets the widget text

Returns:

The widget text

Return type:

Text

property min_desired_width: float

[Read-Write] Min Desired Width

Type:

(float)

set_auto_wrap_text(auto_text_wrap) → None

Set the auto wrap for this text block.

Parameters:

auto_text_wrap (bool) – to turn wrap on or off.

set_color_and_opacity(color_and_opacity) → None

Sets the color and opacity of the text in this text block

Parameters:

color_and_opacity (SlateColor) – The new text color and opacity

set_font(font_info) → None

Dynamically set the font info for this text block

Parameters:

font_info (SlateFontInfo) – The new font info

set_font_material(material) → None

Set Font Material

Parameters:

material (MaterialInterface) –

set_font_outline_material(material) → None

Set Font Outline Material

Parameters:

material (MaterialInterface) –

set_min_desired_width(min_desired_width) → None

Set the minimum desired width for this text block

Parameters:

min_desired_width (float) – new minimum desired width

set_opacity(opacity) → None

Sets the opacity of the text in this text block

Parameters:

opacity (float) – The new text opacity

set_shadow_color_and_opacity(shadow_color_and_opacity) → None

Sets the color and opacity of the text drop shadow Note: if opacity is zero no shadow will be drawn

Parameters:

shadow_color_and_opacity (LinearColor) – The new drop shadow color and opacity

set_shadow_offset(shadow_offset) → None

Sets the offset that the text drop shadow should be drawn at

Parameters:

shadow_offset (Vector2D) – The new offset

set_strike_brush(strike_brush) → None

Dynamically set the strike brush for this text block

Parameters:

strike_brush (SlateBrush) – The new brush to use to strike through text

set_text(text) → None

Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

Parameters:

text (Text) – The text to assign to the widget

set_text_overflow_policy(overflow_policy) → None

Set the text overflow policy for this text block.

Parameters:

overflow_policy (TextOverflowPolicy) – the new text overflow policy.

set_text_transform_policy(transform_policy) → None

Set the text transformation policy for this text block.

Parameters:

transform_policy (TextTransformPolicy) – the new text transformation policy.

property shadow_color_and_opacity: LinearColor

[Read-Write] Shadow Color and Opacity

Type:

(LinearColor)

property shadow_offset: Vector2D

[Read-Write] Shadow Offset

Type:

(Vector2D)

property simple_text_mode: bool

[Read-Only] Simple Text Mode: 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.

Type:

(bool)

property strike_brush: SlateBrush

[Read-Write] Strike Brush

Type:

(SlateBrush)

property text: Text

[Read-Write] Text

Type:

(Text)

property text_overflow_policy: TextOverflowPolicy

[Read-Write] Text Overflow Policy

Type:

(TextOverflowPolicy)

property text_transform_policy: TextTransformPolicy

[Read-Write] Text Transform Policy

Type:

(TextTransformPolicy)

property wrap_with_invalidation_panel: bool

[Read-Only] Wrap with Invalidation Panel: If true, it will automatically wrap this text widget with an invalidation panel

Type:

(bool)