`unreal.ViewportWidgetOverlay`¶

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

Will set the Widgets on a viewport either by Widgets are first rendered to a render target, then that render target is displayed in the world.

C++ Source:

Editor Properties: (see get_editor_property/set_editor_property)

editor_display_type (ViewportWidgetOverlay_DisplayType): [Read-Write] The display type when the world is an editor world.
game_display_type (ViewportWidgetOverlay_DisplayType): [Read-Write] The display type when the world is a game world.
pie_display_type (ViewportWidgetOverlay_DisplayType): [Read-Write] The display type when the world is a PIE world.
post_process_display_type_with_blend_material (ViewportWidgetOverlay_PostProcess): [Read-Write] Behavior when the widget is rendered via a post process material via post process volume settings; the widget is added only over area rendered by anamorphic squeeze.
post_process_with_scene_view_extensions (ViewportWidgetOverlay_PostProcessWithSVE): [Read-Write] Behavior when the widget is rendered via a post process material via SceneViewExtensions; the widget is added over entire viewport, ignoring anamorphic squeeze.
viewport_display_type (ViewportWidgetOverlay_Viewport): [Read-Write] Behavior when the widget should be display by the slate attached to the viewport.
widget_class (type(Class)): [Read-Write] The class of User Widget to create and display an instance of

unreal.ViewportWidgetOverlay¶