unreal.Border
¶
- class unreal.Border(outer: Object | None = None, name: 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] 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.background
(SlateBrush): [Read-Write] Brush to drag as the backgroundbrush_color
(LinearColor): [Read-Write] Color and opacity of the actual border imagecan_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.
content_color_and_opacity
(LinearColor): [Read-Write] Color and opacity multiplier of content in the bordercursor
(MouseCursor): [Read-Write] The cursor to show when the mouse is over the widgetdesired_size_scale
(Vector2D): [Read-Write] Scales the computed desired size of this border and its contents. Useful for making things that slide open without having to hard-code their size. Note: if the parent widget is set up to ignore this widget’s desired size, then changing this value will have no effect.flip_for_right_to_left_flow_direction
(bool): [Read-Write] Flips the background image if the localization’s flow direction is RightToLeftflow_direction_preference
(FlowDirectionPreference): [Read-Write] Allows you to set a new flow directionhorizontal_alignment
(HorizontalAlignment): [Read-Write] The alignment of the content horizontally.is_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.navigation
(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.on_mouse_button_down_event
(OnPointerEvent): [Read-Write]on_mouse_button_up_event
(OnPointerEvent): [Read-Write]on_mouse_double_click_event
(OnPointerEvent): [Read-Write]on_mouse_move_event
(OnPointerEvent): [Read-Write]override_accessible_defaults
(bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write]padding
(Margin): [Read-Write] The padding area between the slot and the content it contains.pixel_snapping
(WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animationrender_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.show_effect_when_disabled
(bool): [Read-Write] Whether or not to show the disabled effect when this border is disabledslot
(PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.tool_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 mousevertical_alignment
(VerticalAlignment): [Read-Write] The alignment of the content vertically.visibility
(SlateVisibility): [Read-Write] The visibility of the widget
- property background: SlateBrush¶
[Read-Only] Brush to drag as the background
- Type:
- property brush_color: LinearColor¶
[Read-Write] Color and opacity of the actual border image
- Type:
- property content_color_and_opacity: LinearColor¶
[Read-Write] Color and opacity multiplier of content in the border
- Type:
- property desired_size_scale: Vector2D¶
[Read-Write] Scales the computed desired size of this border and its contents. Useful for making things that slide open without having to hard-code their size. Note: if the parent widget is set up to ignore this widget’s desired size, then changing this value will have no effect.
- Type:
(Vector2D)
- get_dynamic_material() MaterialInstanceDynamic ¶
Get Dynamic Material
- Return type:
- property horizontal_alignment: HorizontalAlignment¶
[Read-Write] The alignment of the content horizontally.
- Type:
- property padding: Margin¶
[Read-Write] The padding area between the slot and the content it contains.
- 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_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_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] Whether or not to show the disabled effect when this border is disabled
- Type:
(bool)
- property vertical_alignment: VerticalAlignment¶
[Read-Write] The alignment of the content vertically.
- Type: