unreal.NiagaraUIWidget

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

Bases: Widget

Niagara UI Widget

C++ Source:

  • Plugin: NiagaraUIRenderer

  • Module: NiagaraUIRenderer

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

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

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

  • desired_widget_size (Vector2D): [Read-Write] Layout for widget, does not impact simulation coordinate translation

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

  • horizontal_alignment (HorizontalAlignment): [Read-Write] Horizontal alignment that represents the world origin

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

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

  • niagara_system (NiagaraSystem): [Read-Write] System simulation to use

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

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

  • 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

  • vertical_alignment (VerticalAlignment): [Read-Write] Vertical alignment that represents the world origin

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

  • world_to_screen_plane (NiagaraUIScreenPlane): [Read-Write] Axis to translate Niagara to UI

  • world_to_screen_scale (float): [Read-Write] Scale to translate Niagara units to UI units

property desired_widget_size: Vector2D

[Read-Write] Layout for widget, does not impact simulation coordinate translation

Type:

(Vector2D)

property horizontal_alignment: HorizontalAlignment

[Read-Write] Horizontal alignment that represents the world origin

Type:

(HorizontalAlignment)

property niagara_system: NiagaraSystem

[Read-Write] System simulation to use

Type:

(NiagaraSystem)

set_desired_widget_size(size) → None

END: UWidget interface

Parameters:

size (Vector2D)

property vertical_alignment: VerticalAlignment

[Read-Write] Vertical alignment that represents the world origin

Type:

(VerticalAlignment)

property world_to_screen_plane: NiagaraUIScreenPlane

[Read-Write] Axis to translate Niagara to UI

Type:

(NiagaraUIScreenPlane)

property world_to_screen_scale: float

[Read-Write] Scale to translate Niagara units to UI units

Type:

(float)