unreal.SafeZone

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

Bases: ContentWidget

The Safe-Zone widget is an essential part of developing a game UI that can run on lots of different non-PC platforms. While a modern flat panel computer monitor may not have over scan issues, this is a common occurrence for Consoles. It’s common for TVs to have extra pixels under the bezel, in addition to projectors and projection TVs having potentially several vertical and horizontal columns of pixels hidden behind or against a black border of the projection screen.

Useful testing console commands to help, simulate the safe zone on PC,

r.DebugSafeZone.TitleRatio 0.96 r.DebugActionZone.ActionRatio 0.96

To enable a red band to visualize the safe zone, use this console command, r.DebugSafeZone.Mode controls the debug visualization overlay (0..2, default 0).

0: Do not display the safe zone overlay. 1: Display the overlay for the title safe zone. 2: Display the overlay for the action safe zone.

C++ Source:

  • Module: UMG

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

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

  • 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

  • pad_bottom (bool): [Read-Write] Pad Bottom: If this safe zone should pad for the bottom side of the screen’s safe zone

  • pad_left (bool): [Read-Write] Pad Left: If this safe zone should pad for the left side of the screen’s safe zone

  • pad_right (bool): [Read-Write] Pad Right: If this safe zone should pad for the right side of the screen’s safe zone

  • pad_top (bool): [Read-Write] Pad Top: If this safe zone should pad for the top side of the screen’s safe zone

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

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

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

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

property pad_bottom: bool

[Read-Only] Pad Bottom: If this safe zone should pad for the bottom side of the screen’s safe zone

Type:

(bool)

property pad_left: bool

[Read-Only] Pad Left: If this safe zone should pad for the left side of the screen’s safe zone

Type:

(bool)

property pad_right: bool

[Read-Only] Pad Right: If this safe zone should pad for the right side of the screen’s safe zone

Type:

(bool)

property pad_top: bool

[Read-Only] Pad Top: If this safe zone should pad for the top side of the screen’s safe zone

Type:

(bool)

set_sides_to_pad(pad_left, pad_right, pad_top, pad_bottom) → None

Set Sides to Pad

Parameters:

  • pad_left (bool) –

  • pad_right (bool) –

  • pad_top (bool) –

  • pad_bottom (bool) –