unreal.DMRenderTargetTextRenderer

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

Bases: DMRenderTargetWidgetRendererBase

Renderer that renders an STextBlock widget and exposes all its parameters/properties.

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterial

  • File: DMRenderTargetTextRenderer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_wrap_text (bool): [Read-Write]

  • component_dirty (bool): [Read-Only]

  • component_state (DMComponentLifetimeState): [Read-Only]

  • editable_properties (Array[Name]): [Read-Only]

  • flow_direction (TextFlowDirection): [Read-Write]

  • font_info (SlateFontInfo): [Read-Write]

  • has_highlight (bool): [Read-Write]

  • has_shadow (bool): [Read-Write]

  • highlight_color (LinearColor): [Read-Write]

  • justify (TextJustify): [Read-Write]

  • line_height (float): [Read-Write] Multiplier on the base font height.

  • override_render_target_size (bool): [Read-Write] When true, will change the size of the render target to fit the text.

  • padding_bottom (float): [Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

  • padding_left (float): [Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

  • padding_right (float): [Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

  • padding_top (float): [Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

  • shadow_color (LinearColor): [Read-Write]

  • shadow_offset (Vector2D): [Read-Write]

  • shaping_method (TextShapingMethod): [Read-Write]

  • strike_brush (InstancedStruct): [Read-Write]

  • text (Text): [Read-Write]

  • text_color (LinearColor): [Read-Write]

  • transform_policy (TextTransformPolicy): [Read-Write]

  • wrap_text_at (float): [Read-Write]

  • wrapping_policy (TextWrappingPolicy): [Read-Write]

property auto_wrap_text: bool

[Read-Write]

Type:

(bool)

copy_parameters_from(other) → None

Copies the parameter-based value of the given value to this value, if possible.

Parameters:

other (Object)

property flow_direction: TextFlowDirection

[Read-Write]

Type:

(TextFlowDirection)

property font_info: SlateFontInfo

[Read-Write]

Type:

(SlateFontInfo)

get_auto_wrap_text() → bool

Get Auto Wrap Text

Return type:

bool

get_background_color() → LinearColor

Get Background Color

Return type:

LinearColor

get_flow_direction() → TextFlowDirection

Get Flow Direction

Return type:

TextFlowDirection

get_font_info() → SlateFontInfo

Get Font Info

Return type:

SlateFontInfo

get_has_highlight() → bool

Get Has Highlight

Return type:

bool

get_has_shadow() → bool

Get Has Shadow

Return type:

bool

get_highlight_color() → LinearColor

Get Highlight Color

Return type:

LinearColor

get_justify() → TextJustify

Get Justify

Return type:

TextJustify

get_line_height() → float

Get Line Height

Return type:

float

get_padding_bottom() → float

Get Padding Bottom

Return type:

float

get_padding_left() → float

Get Padding Left

Return type:

float

get_padding_right() → float

Get Padding Right

Return type:

float

get_padding_top() → float

Get Padding Top

Return type:

float

get_shadow_color() → LinearColor

Get Shadow Color

Return type:

LinearColor

get_shadow_offset() → Vector2D

Get Shadow Offset

Return type:

Vector2D

get_shaping_method() → TextShapingMethod

Get Shaping Method

Return type:

TextShapingMethod

get_strike_brush() → InstancedStruct

Get Strike Brush

Return type:

InstancedStruct

get_text() → Text

Get Text

Return type:

Text

get_text_color() → LinearColor

Get Text Color

Return type:

LinearColor

get_transform_policy() → TextTransformPolicy

Get Transform Policy

Return type:

TextTransformPolicy

get_wrap_text_at() → float

Get Wrap Text At

Return type:

float

get_wrapping_policy() → TextWrappingPolicy

Get Wrapping Policy

Return type:

TextWrappingPolicy

property has_highlight: bool

[Read-Write]

Type:

(bool)

property has_shadow: bool

[Read-Write]

Type:

(bool)

property highlight_color: LinearColor

[Read-Write]

Type:

(LinearColor)

is_overriding_render_target_size() → bool

Is Overriding Render Target Size

Return type:

bool

property justify: TextJustify

[Read-Write]

Type:

(TextJustify)

property line_height: float

[Read-Write] Multiplier on the base font height.

Type:

(float)

property override_render_target_size: bool

[Read-Write] When true, will change the size of the render target to fit the text.

Type:

(bool)

property padding_bottom: float

[Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

Type:

(float)

property padding_left: float

[Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

Type:

(float)

property padding_right: float

[Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

Type:

(float)

property padding_top: float

[Read-Write] Extra space adding beyond the edge of the glyphs. Useful for shadows, glows, etc.

Type:

(float)

set_auto_wrap_text(auto_wrap) → None

Set Auto Wrap Text

Parameters:

auto_wrap (bool)

set_background_color(background_color) → None

Set Background Color

Parameters:

background_color (LinearColor)

set_flow_direction(flow_direction) → None

Set Flow Direction

Parameters:

flow_direction (TextFlowDirection)

set_font_info(font_info) → None

Set Font Info

Parameters:

font_info (SlateFontInfo)

set_has_highlight(has_highlight) → None

Set Has Highlight

Parameters:

has_highlight (bool)

set_has_shadow(has_shadow) → None

Set Has Shadow

Parameters:

has_shadow (bool)

set_highlight_color(highlight_color) → None

Set Highlight Color

Parameters:

highlight_color (LinearColor)

set_justify(justify) → None

Set Justify

Parameters:

justify (TextJustify)

set_line_height(line_height) → None

Set Line Height

Parameters:

line_height (float)

set_override_render_target_size(override) → None

Set Override Render Target Size

Parameters:

override (bool)

set_padding_bottom(padding) → None

Set Padding Bottom

Parameters:

padding (float)

set_padding_left(padding) → None

Set Padding Left

Parameters:

padding (float)

set_padding_right(padding) → None

Set Padding Right

Parameters:

padding (float)

set_padding_top(padding) → None

Set Padding Top

Parameters:

padding (float)

set_shadow_color(shadow_color) → None

Set Shadow Color

Parameters:

shadow_color (LinearColor)

set_shadow_offset(shadow_offset) → None

Set Shadow Offset

Parameters:

shadow_offset (Vector2D)

set_shaping_method(shaping_method) → None

Set Shaping Method

Parameters:

shaping_method (TextShapingMethod)

set_strike_brush(strike_brush) → None

Set Strike Brush

Parameters:

strike_brush (InstancedStruct)

set_text(text) → None

Set Text

Parameters:

text (Text)

set_text_color(color) → None

Set Text Color

Parameters:

color (LinearColor)

set_transform_policy(transform_policy) → None

Set Transform Policy

Parameters:

transform_policy (TextTransformPolicy)

set_wrap_text_at(wrap_at) → None

Set Wrap Text At

Parameters:

wrap_at (float)

set_wrapping_policy(wrapping_policy) → None

Set Wrapping Policy

Parameters:

wrapping_policy (TextWrappingPolicy)

property shadow_color: LinearColor

[Read-Write]

Type:

(LinearColor)

property shadow_offset: Vector2D

[Read-Write]

Type:

(Vector2D)

property shaping_method: TextShapingMethod

[Read-Write]

Type:

(TextShapingMethod)

property strike_brush: InstancedStruct

[Read-Write]

Type:

(InstancedStruct)

property text: Text

[Read-Write]

Type:

(Text)

property text_color: LinearColor

[Read-Write]

Type:

(LinearColor)

property transform_policy: TextTransformPolicy

[Read-Write]

Type:

(TextTransformPolicy)

property wrap_text_at: float

[Read-Write]

Type:

(float)

property wrapping_policy: TextWrappingPolicy

[Read-Write]

Type:

(TextWrappingPolicy)