unreal.DynamicEntryBox

class unreal.DynamicEntryBox(outer=None, name='None')

Bases: unreal.Widget

A special box panel that auto-generates its entries at both design-time and runtime. Useful for cases where you can have a varying number of entries, but it isn’t worth the effort or conceptual overhead to set up a list/tile view. Note that entries here are not virtualized as they are in the list views, so generally this should be avoided if you intend to scroll through lots of items.

No children can be manually added in the designer - all are auto-generated based on the given entry class.

C++ Source:

  • Module: UMG
  • File: DynamicEntryBox.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • entry_box_type (DynamicBoxType): [Read-Write] 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] Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

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

  • entry_spacing (Vector2D): [Read-Write] 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] Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

  • entry_widget_class (type(Class)): [Read-Write] The class of widget to create entries of. If natively binding this widget, use the EntryClass UPROPERTY metadata to specify the desired entry widget base class.

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

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

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

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

  • num_designer_preview_entries (int32): [Read-Write] Num Designer Preview Entries

  • override_cursor (bool): [Read-Write] Override Cursor

  • render_opacity (float): [Read-Write] The opacity of the widget

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

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

  • spacing_pattern (Array(Vector2D)): [Read-Write] 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] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

bp_create_entry() → UserWidget

Creates and establishes a new dynamic entry in the box

Returns:
Return type:UserWidget
bp_create_entry_of_class(entry_class) → UserWidget

Creates and establishes a new dynamic entry in the box using the specified class instead of the default.

Parameters:entry_class (type(Class)) –
Returns:
Return type:UserWidget
entry_horizontal_alignment

(HorizontalAlignment) – [Read-Only] Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

entry_size_rule

(SlateChildSize) – [Read-Only] Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.

entry_spacing

(Vector2D) – [Read-Only] 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-Only] Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

entry_widget_class

(type(Class)) – [Read-Only] The class of widget to create entries of. If natively binding this widget, use the EntryClass UPROPERTY metadata to specify the desired entry widget base class.

get_all_entries() -> Array(UserWidget)

Get All Entries

Returns:
Return type:Array(UserWidget)
get_num_entries() → int32

Get Num Entries

Returns:
Return type:int32
max_element_size

(int32) – [Read-Only] The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.

remove_entry(entry_widget) → None

Remove Entry

Parameters:entry_widget (UserWidget) –
reset(delete_widgets=False) → None

Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well.

Parameters:delete_widgets (bool) –
set_entry_spacing(entry_spacing) → None

Set Entry Spacing

Parameters:entry_spacing (Vector2D) –
spacing_pattern

(Array(Vector2D)) – [Read-Only] The looping sequence of entry paddings to apply as entries are created. Overlay boxes only. Ignores EntrySpacing if not empty.