unreal.TextBlock
¶
- class unreal.TextBlock(outer=None, name='None')¶
Bases:
unreal.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] 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.auto_wrap_text
(bool): [Read-Write] True if we’re wrapping text automatically based on the computed horizontal space for this widget.auto_wrap_text
(bool): [Read-Write] Whether the text should automatically wrap deprecated: bAutoWrapText is deprecated. Please use AutoWrapText instead.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 textcursor
(MouseCursor): [Read-Write] The cursor to show when the mouse is over the widgetflow_direction_preference
(FlowDirectionPreference): [Read-Write] Allows you to set a new flow directionfont
(SlateFontInfo): [Read-Write] The font to render the text withis_enabled
(bool): [Read-Write] Sets whether this widget can be modified interactively by the useris_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 textnavigation
(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.override_accessible_defaults
(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write] Override Cursorrender_opacity
(float): [Read-Write] The opacity of the widgetrender_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.shadow_color_and_opacity
(LinearColor): [Read-Write] The color of the shadowshadow_offset
(Vector2D): [Read-Write] The direction the shadow is castshaped_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 withtext
(Text): [Read-Write] The text to displaytext_transform_policy
(TextTransformPolicy): [Read-Write] The text transformation policy to apply to this text blocktool_tip_text
(Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mousetool_tip_widget
(Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mousevisibility
(SlateVisibility): [Read-Write] The visibility of the widgetwrap_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 panelwrapping_policy
(TextWrappingPolicy): [Read-Write] The wrapping policy to use.
- property auto_wrap_text¶
[Read-Write] Whether the text should automatically wrap deprecated: bAutoWrapText is deprecated. Please use AutoWrapText instead.
- Type
(bool)
- property color_and_opacity¶
[Read-Only] The color of the text
- Type
- property font¶
[Read-Only] The font to render the text with
- Type
- get_dynamic_font_material() → MaterialInstanceDynamic¶
Get Dynamic Font Material
- Returns
- Return type
- get_dynamic_outline_material() → MaterialInstanceDynamic¶
Get Dynamic Outline Material
- Returns
- Return type
- 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_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_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¶
[Read-Only] The color of the shadow
- Type
- property simple_text_mode¶
[Read-Only] 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¶
[Read-Only] The brush to strike through text with
- Type
- property text_transform_policy¶
[Read-Only] The text transformation policy to apply to this text block
- Type