unreal.CommonTextStyle

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

Bases: Object

  • —- All properties must be EditDefaultsOnly, BlueprintReadOnly !!! —–

  • We return the CDO to blueprints, so we cannot allow any changes (blueprint doesn’t support const variables)

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonTextBlock.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

  • font (SlateFontInfo): [Read-Write] The font to apply at each size

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

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

  • shadow_color (LinearColor): [Read-Write] The drop shadow color

  • shadow_offset (Vector2D): [Read-Write] The offset of the drop shadow at each size

  • strike_brush (SlateBrush): [Read-Write] The brush used to draw an strike through the text (if any)

  • uses_drop_shadow (bool): [Read-Write] Whether or not the style uses a drop shadow

property apply_line_height_to_bottom_line: bool

[Read-Only] Whether to leave extra space below the last line due to line height

Type:

(bool)

property color: LinearColor

[Read-Only] The color of the text

Type:

(LinearColor)

property font: SlateFontInfo

[Read-Only] The font to apply at each size

Type:

(SlateFontInfo)

get_apply_line_height_to_bottom_line() → bool

Get Apply Line Height to Bottom Line

Return type:

bool

get_color() → LinearColor

Get Color

Returns:

out_color (LinearColor):

Return type:

LinearColor

get_font() → SlateFontInfo

Get Font

Returns:

out_font (SlateFontInfo):

Return type:

SlateFontInfo

get_line_height_percentage() → float

Get Line Height Percentage

Return type:

float

get_margin() → Margin

Get Margin

Returns:

out_margin (Margin):

Return type:

Margin

get_shadow_color() → LinearColor

Get Shadow Color

Returns:

out_color (LinearColor):

Return type:

LinearColor

get_shadow_offset() → Vector2D

Get Shadow Offset

Returns:

out_shadow_offset (Vector2D):

Return type:

Vector2D

get_strike_brush() → SlateBrush

Get Strike Brush

Returns:

out_strike_brush (SlateBrush):

Return type:

SlateBrush

property line_height_percentage: float

[Read-Only] The amount to scale each lines height by at each size

Type:

(float)

property margin: Margin

[Read-Only] The amount of blank space left around the edges of text area at each size

Type:

(Margin)

property shadow_color: LinearColor

[Read-Only] The drop shadow color

Type:

(LinearColor)

property shadow_offset: Vector2D

[Read-Only] The offset of the drop shadow at each size

Type:

(Vector2D)

property strike_brush: SlateBrush

[Read-Only] The brush used to draw an strike through the text (if any)

Type:

(SlateBrush)

property uses_drop_shadow: bool

[Read-Only] Whether or not the style uses a drop shadow

Type:

(bool)