unreal.Border

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

Bases: ContentWidget

A border is a container widget that can contain one child widget, providing an opportunity to surround it with a background image and adjustable padding.

  • Single Child

  • Image

C++ Source:

  • Module: UMG

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

  • background (SlateBrush): [Read-Write] Background: Brush to drag as the background

  • brush_color (LinearColor): [Read-Write] Brush Color

  • 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

  • content_color_and_opacity (LinearColor): [Read-Write] Content Color and Opacity

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

  • desired_size_scale (Vector2D): [Read-Write] Desired Size Scale

  • flip_for_right_to_left_flow_direction (bool): [Read-Write] Flip for Right to Left Flow Direction: Flips the background image if the localization’s flow direction is RightToLeft

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

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal Alignment

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

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

  • on_mouse_button_down_event (OnPointerEvent): [Read-Write] On Mouse Button Down Event

  • on_mouse_button_up_event (OnPointerEvent): [Read-Write] On Mouse Button Up Event

  • on_mouse_double_click_event (OnPointerEvent): [Read-Write] On Mouse Double Click Event

  • on_mouse_move_event (OnPointerEvent): [Read-Write] On Mouse Move Event

  • 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

  • padding (Margin): [Read-Write] Padding

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

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

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

  • show_effect_when_disabled (bool): [Read-Write] Show Effect when Disabled

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

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

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

  • vertical_alignment (VerticalAlignment): [Read-Write] Vertical Alignment

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

property background: SlateBrush

[Read-Only] Background: Brush to drag as the background

Type:

(SlateBrush)

property brush_color: LinearColor

[Read-Write] Brush Color

Type:

(LinearColor)

property content_color_and_opacity: LinearColor

[Read-Write] Content Color and Opacity

Type:

(LinearColor)

property desired_size_scale: Vector2D

[Read-Write] Desired Size Scale

Type:

(Vector2D)

get_dynamic_material() MaterialInstanceDynamic

Get Dynamic Material

Return type:

MaterialInstanceDynamic

property horizontal_alignment: HorizontalAlignment

[Read-Write] Horizontal Alignment

Type:

(HorizontalAlignment)

property padding: Margin

[Read-Write] Padding

Type:

(Margin)

set_brush(brush) None

Set Brush

Parameters:

brush (SlateBrush) –

set_brush_color(brush_color) None

Set Brush Color

Parameters:

brush_color (LinearColor) –

set_brush_from_asset(asset) None

Set Brush from Asset

Parameters:

asset (SlateBrushAsset) –

set_brush_from_material(material) None

Set Brush from Material

Parameters:

material (MaterialInterface) –

set_brush_from_texture(texture) None

Set Brush from Texture

Parameters:

texture (Texture2D) –

set_content_color_and_opacity(content_color_and_opacity) None

Set Content Color and Opacity

Parameters:

content_color_and_opacity (LinearColor) –

set_desired_size_scale(scale) None

Sets the DesiredSizeScale of this border.

Parameters:

scale (Vector2D) – The X and Y multipliers for the desired size

set_horizontal_alignment(horizontal_alignment) None

Set Horizontal Alignment

Parameters:

horizontal_alignment (HorizontalAlignment) –

set_padding(padding) None

Set Padding

Parameters:

padding (Margin) –

set_show_effect_when_disabled(show_effect_when_disabled) None

Set Show Effect when Disabled

Parameters:

show_effect_when_disabled (bool) –

set_vertical_alignment(vertical_alignment) None

Set Vertical Alignment

Parameters:

vertical_alignment (VerticalAlignment) –

property show_effect_when_disabled: bool

[Read-Write] Show Effect when Disabled

Type:

(bool)

property vertical_alignment: VerticalAlignment

[Read-Write] Vertical Alignment

Type:

(VerticalAlignment)