unreal.DynamicEntryBoxBase

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

Bases: Widget

Base for widgets that support a dynamic number of auto-generated entries at both design- and run-time. Contains all functionality needed to create, construct, and cache an arbitrary number of entry widgets, but exposes no means of entry creation or removal It’s up to child classes to decide how they want to perform the population (some may do so entirely on their own without exposing a thing) see: UDynamicEntryBox for a ready-to-use version

C++ Source:

  • Module: UMG

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

  • 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

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

  • entry_box_type (DynamicBoxType): [Read-Write] Entry Box Type: The type of box panel into which created entries are added. Some differences in functionality exist between each type.

  • entry_horizontal_alignment (HorizontalAlignment): [Read-Write] Entry Horizontal Alignment: Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

  • entry_size_rule (SlateChildSize): [Read-Write] Entry Size Rule: Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.

  • entry_spacing (Vector2D): [Read-Write] Entry Spacing: The padding to apply between entries in the box. Note horizontal boxes only use the X and vertical boxes only use Y. Value is also ignored for the first entry in the box. Wrap and Overlay types use both X and Y for spacing.

  • entry_vertical_alignment (VerticalAlignment): [Read-Write] Entry Vertical Alignment: Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

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

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

  • max_element_size (int32): [Read-Write] Max Element Size: The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.

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

  • 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

  • radial_box_settings (RadialBoxSettings): [Read-Write] Radial Box Settings: Settings only relevant to RadialBox

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

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

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

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

  • spacing_pattern (Array[Vector2D]): [Read-Write] Spacing Pattern: The looping sequence of entry paddings to apply as entries are created. Overlay boxes only. Ignores EntrySpacing if not empty.

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

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

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

property entry_horizontal_alignment: HorizontalAlignment

[Read-Only] Entry Horizontal Alignment: Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

Type:

(HorizontalAlignment)

property entry_size_rule: SlateChildSize

[Read-Only] Entry Size Rule: Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.

Type:

(SlateChildSize)

property entry_spacing: Vector2D

[Read-Only] Entry Spacing: The padding to apply between entries in the box. Note horizontal boxes only use the X and vertical boxes only use Y. Value is also ignored for the first entry in the box. Wrap and Overlay types use both X and Y for spacing.

Type:

(Vector2D)

property entry_vertical_alignment: VerticalAlignment

[Read-Only] Entry Vertical Alignment: Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

Type:

(VerticalAlignment)

get_all_entries() → Array[UserWidget]

Get All Entries

Return type:

Array[UserWidget]

get_num_entries() → int32

Get Num Entries

Return type:

int32

property max_element_size: int

[Read-Only] Max Element Size: The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.

Type:

(int32)

property radial_box_settings: RadialBoxSettings

[Read-Only] Radial Box Settings: Settings only relevant to RadialBox

Type:

(RadialBoxSettings)

set_entry_spacing(entry_spacing) → None

Set Entry Spacing

Parameters:

entry_spacing (Vector2D) –

set_radial_settings(settings) → None

Set Radial Settings

Parameters:

settings (RadialBoxSettings) –

property spacing_pattern: Array[Vector2D]

[Read-Only] Spacing Pattern: The looping sequence of entry paddings to apply as entries are created. Overlay boxes only. Ignores EntrySpacing if not empty.

Type:

(Array[Vector2D])