Class SafeZone

The Safe-Zone widget is an essential part of developing a game UI that can run on lots of different non-PC platforms.

Inheritance
System.Object
UObject
Visual
Widget
PanelWidget
ContentWidget
SafeZone
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class SafeZone : ContentWidget
Remarks

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.

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static SafeZone DefaultObject { get; }
Property Value
Type Description
SafeZone
| Improve this Doc View Source

PadBottom

Declaration
public bool PadBottom { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PadLeft

Declaration
public bool PadLeft { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PadRight

Declaration
public bool PadRight { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PadTop

Declaration
public bool PadTop { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static SafeZone New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
SafeZone
| Improve this Doc View Source

SetSidesToPad(Boolean, Boolean, Boolean, Boolean)

Set Sides to Pad

Declaration
public void SetSidesToPad(bool InPadLeft, bool InPadRight, bool InPadTop, bool InPadBottom)
Parameters
Type Name Description
System.Boolean InPadLeft
System.Boolean InPadRight
System.Boolean InPadTop
System.Boolean InPadBottom

Operators

| Improve this Doc View Source

Implicit(IntPtr to SafeZone)

Convert from IntPtr to UObject

Declaration
public static implicit operator SafeZone(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
SafeZone