unreal.RichTextBlock

class unreal.RichTextBlock(outer=None, name='None')

Bases: unreal.TextLayoutWidget

The rich text block

  • Fancy Text

  • No Children

C++ Source:

  • Module: UMG

  • File: RichTextBlock.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: 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.

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

  • decorator_classes (Array(type(Class))): [Read-Write] Decorator Classes

  • default_text_style_override (TextBlockStyle): [Read-Write] Default Text Style Override: Text style to apply by default to text in this block

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

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

  • 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: The minimum desired size for the text

  • 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

  • override_default_style (bool): [Read-Write] Override Default Style: True to specify the default text style for this rich text inline, overriding any default provided in the style set table

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

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

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot: 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.

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

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

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

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

  • text_style_set (DataTable): [Read-Write] Text Style Set

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

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

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

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

  • 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.

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

get_decorator_by_class(decorator_class) → RichTextBlockDecorator

Get Decorator by Class

Parameters

decorator_class (type(Class)) –

Return type

RichTextBlockDecorator

get_default_dynamic_material() → MaterialInstanceDynamic

Creates a dynamic material for the default font or returns it if it already exists

Return type

MaterialInstanceDynamic

get_text() → Text

Returns widgets text.

Return type

Text

property min_desired_width

[Read-Only] Min Desired Width: The minimum desired size for the text

Type

(float)

refresh_text_layout() → None

Causes the text to reflow it’s layout and re-evaluate any decorators

set_auto_wrap_text(auto_text_wrap) → None

Set the auto wrap for this rich text block

Parameters

auto_text_wrap (bool) – to turn wrap on or off

set_default_color_and_opacity(color_and_opacity) → None

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

Parameters

color_and_opacity (SlateColor) – The new text color and opacity

set_default_font(font_info) → None

Dynamically set the default font info for this rich text block

Parameters

font_info (SlateFontInfo) – The new font info

set_default_shadow_color_and_opacity(shadow_color_and_opacity) → None

Sets the color and opacity of the default 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_default_shadow_offset(shadow_offset) → None

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

Parameters

shadow_offset (Vector2D) – The new offset

set_default_strike_brush() → SlateBrush

Dynamically set the default strike brush for this rich text block

Returns

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

Return type

SlateBrush

set_default_text_style(default_text_style) → None

Wholesale override of the currently established default text style

Parameters

default_text_style (TextBlockStyle) – The new text style to apply to all default (i.e. undecorated) text in the block

set_min_desired_width(min_desired_width) → None

Set the minimum desired width for this rich text block

Parameters

min_desired_width (float) – new minimum desired width

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_style_set(new_text_style_set) → None

Set Text Style Set

Parameters

new_text_style_set (DataTable) –

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 text_overflow_policy

[Read-Write] Text Overflow Policy: Sets what happens to text that is clipped and doesn’t fit within the clip rect for this widget

Type

(TextOverflowPolicy)

property text_transform_policy

[Read-Only] Text Transform Policy: The text transformation policy to apply to this text block

Type

(TextTransformPolicy)