1. Epic GamesDeveloper
  3. ULevelEditorPlaySettings

ULevelEditorPlaySettings

Implements the Editor's play settings.

API > API/Editor > API/Editor/UnrealEd

Implements the Editor's play settings.

   
Name ULevelEditorPlaySettings
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Settings/LevelEditorPlaySettings.h
Include Path #include "Settings/LevelEditorPlaySettings.h"

Syntax

UCLASS (Config=EditorPerProjectUserSettings, MinimalAPI)  
class ULevelEditorPlaySettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ULevelEditorPlaySettings ( const FObjectInitializer& ObjectInitializer
)

   Settings/LevelEditorPlaySettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AdditionalLaunchParameters FString Extra parameters to be include as part of the command line for the standalone game. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInStandaloneGame
AdditionalServerLaunchParameters FString Additional options that will be passed to the server as arguments, for example -debug. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Server"
AutoRecompileBlueprints bool Whether to automatically recompile blueprints on PIE Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Automatically recompile blueprints used by the current level when initiating a Play In Editor session")
bAutoCompileBlueprintsOnLaunch bool Whether to automatically recompile dirty Blueprints before launching Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayOnDevice
bEmulateStereo bool Whether we should emulate stereo (helps checking VR rendering issues). Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInStandaloneGame
bLaunchSeparateServer bool This is a rarely used option that will launch a separate server (possibly hidden in-process depending on RunUnderOneProcess) even if the net mode does not require a server (such as Standalone). Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
bOnlyLoadVisibleLevelsInPIE uint32 True if Play In Editor should only load currently-visible levels in PIE. Settings/LevelEditorPlaySettings.h
  • Config
bPreferToStreamLevelsInPIE uint32   Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(DisplayName="Stream Sub-Levels during Play in Editor", ToolTip="Prefer to stream sub-levels from the disk instead of duplicating editor sub-levels")
bPromoteOutputLogWarningsDuringPIE bool Should warnings and errors in the Output Log during "Play in Editor" be promoted to the message log? Settings/LevelEditorPlaySettings.h
  • EditAnywhere
  • Config
  • Category=PlayInEditor
bShouldMinimizeEditorOnNonVRPIE bool Should we minimize the editor when non-VR PIE is clicked (default = false) Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Whether or not the editor is minimized on non-VR PIE")
BuildGameBeforeLaunch TEnumAsByte< EPlayOnBuildMode > Whether to build the game before launching on device. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayOnDevice
bUseNonRealtimeAudioDevice bool Whether to use a non-realtime audio device during PIE Settings/LevelEditorPlaySettings.h
  • Config
CenterNewWindow uint32 Whether the new window should be centered on the screen. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=GameViewportSettings
ClientFixedFPS TArray< int32 > If > 0, Tick clients at a fixed frame rate. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(EditCondition="PlayNetMode != EPlayNetMode::PIE_Standalone && RunUnderOneProcess")
CustomUnsafeZoneDimensions TArray< FVector2D >   Settings/LevelEditorPlaySettings.h
  • Config
CustomUnsafeZoneStarts TArray< FVector2D >   Settings/LevelEditorPlaySettings.h
  • Config
DeviceToEmulate FString   Settings/LevelEditorPlaySettings.h
  • Config
  • VisibleAnywhere
  • Category=GameViewportSettings
DisableStandaloneSound uint32 Whether sound should be disabled when playing standalone games. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInStandaloneGame
EnableGameSound bool Whether to play sounds during PIE Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Whether to play sounds when in a Play In Editor session")
EnablePIEEnterAndExitSounds bool Whether to play a sound when entering and exiting PIE Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • AdvancedDisplay
  • Category=PlayInEditor
  • Meta=(DisplayName="Enable PIE Enter and Exit Sounds")
GameGetsMouseControl bool Should Play-in-Editor automatically give mouse control to the game on PIE start (default = false). Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Give the game mouse control when PIE starts or require a click in the viewport first")
LaptopScreenResolutions TArray< FPlayScreenResolution > Collection of common screen resolutions on mobile phones. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedLaunchDevice FString The name of the last platform that the user ran a play session on. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedLaunchModeType TEnumAsByte< ELaunchModeType > The last type of play-on session the user ran. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedLaunchName FString The name of the last device that the user ran a play session on. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedPIEPreviewDevice FString The name of the last device that the user ran a play session on. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedPlayModeLocation TEnumAsByte< EPlayModeLocations > The last type of play location the user ran. Settings/LevelEditorPlaySettings.h
  • Config
LastExecutedPlayModeType TEnumAsByte< EPlayModeType > The last type of play session the user ran. Settings/LevelEditorPlaySettings.h
  • Config
LastSize FIntPoint The last known screen size for the first instance window (in pixels). Settings/LevelEditorPlaySettings.h
  • Config
LaunchConfiguration TEnumAsByte< EPlayOnLaunchConfiguration > Which build configuration to use when launching on device. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayOnDevice
MonitorScreenResolutions TArray< FPlayScreenResolution > Collection of common screen resolutions on desktop monitors. Settings/LevelEditorPlaySettings.h
  • Config
MouseControlLabelPosition TEnumAsByte< ELabelAnchorMode > Location on screen to anchor the mouse control label when in PIE mode. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
MultipleInstancePositions TArray< FIntPoint > The last known screen positions of multiple instance windows (in pixels). Settings/LevelEditorPlaySettings.h
  • Config
NetworkEmulationSettings FLevelEditorPlayNetworkEmulationSettings Customizable settings allowing to emulate latency and packetloss for game network transmissions Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
NewWindowHeight int32 The height of the new view port window in pixels (0 = use the desktop's screen resolution). Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=GameViewportSettings
  • Meta=(ClampMin=0)
NewWindowPosition FIntPoint The position of the new view port window on the screen in pixels. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=GameViewportSettings
NewWindowWidth int32 The width of the new view port window in pixels (0 = use the desktop's screen resolution). Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=GameViewportSettings
  • Meta=(ClampMin=0)
PackFilesForLaunch EPlayOnPakFileMode Whether to content should be stored in pak files when launching on device. */. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayOnDevice
PhoneScreenResolutions TArray< FPlayScreenResolution > Collection of common screen resolutions on mobile phones. Settings/LevelEditorPlaySettings.h
  • Config
PIEAlwaysOnTop uint32 Whether to always have the PIE window on top of the parent windows. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInNewWindow
  • Meta=(ToolTip="Always have the PIE window on top of the parent windows.")
PIESafeZoneOverride FMargin   Settings/LevelEditorPlaySettings.h
  • Config
PlayFromHerePlayerStartClassName FString The PlayerStart class used when spawning the player at the current camera location. Settings/LevelEditorPlaySettings.h
  • GlobalConfig
PlayInEditorSoundQualityLevel int32 Which quality level to use when playing in editor Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
ServerFixedFPS int32 If > 0, Tick dedicated server at a fixed frame rate. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Server"
  • Meta=(EditCondition="PlayNetMode == EPlayNetMode::PIE_Client && RunUnderOneProcess")
ShouldMinimizeEditorOnVRPIE bool Should we minimize the editor when VR PIE is clicked (default = true) Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Whether or not the editor is minimized on VR PIE")
ShowMouseControlLabel bool Whether to show a label for mouse control gestures in the PIE view. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
SoloAudioInFirstPIEClient bool Whether to automatically solo audio in first PIE client. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Whether to automatically solo audio in first PIE client", EditCondition="EnableGameSound", DisplayName="Solo Audio in First PIE Client")
TabletScreenResolutions TArray< FPlayScreenResolution > Collection of common screen resolutions on tablet devices. Settings/LevelEditorPlaySettings.h
  • Config
TelevisionScreenResolutions TArray< FPlayScreenResolution > Collection of common screen resolutions on television screens. Settings/LevelEditorPlaySettings.h
  • Config
UseMouseForTouch bool While using the game viewport, it sends mouse movement and clicks as touch events, instead of as mouse events. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
ViewportGetsHMDControl bool Should Play-in-Viewport respect HMD orientations (default = false) Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category=PlayInEditor
  • Meta=(ToolTip="Whether or not HMD orientation should be used when playing in viewport")

Protected

Name Type Remarks Include Path Unreal Specifiers
AdditionalServerGameOptions FString Additional options that will be passed to the server as URL parameters, in the format ?bIsLanMatch=1?listen - any additional command line switches should be passed in the Additional Server Launch Parameters field below. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Server"
  • Meta=(EditCondition="PlayNetMode != EPlayNetMode::PIE_Standalone || bLaunchSeparateServer")
bHMDForPrimaryProcessOnly bool When running multiple player windows in multiple processes, this option determines how HMD(s)/Simulator(s) is/are attached to processes. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
  • Meta=(DisplayName="HMD For Primary Process Only", EditCondition="!RunUnderOneProcess")
bShowServerDebugDrawingByDefault bool Controls the default value of the show flag ServerDrawDebug Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
ClientWindowHeight int32 Height to use when spawning additional windows. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(ClampMin=0)
ClientWindowWidth int32 Width to use when spawning additional windows. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(ClampMin=0)
CreateAudioDeviceForEveryPlayer bool If checked, a separate audio device is created for every player. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(EditCondition="EnableGameSound && RunUnderOneProcess")
PlayNetMode TEnumAsByte< EPlayNetMode > NetMode to use for Play In Editor. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
PlayNumberOfClients int32 The number of client windows to open. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(ClampMin="1", UIMin="1", UIMax="64")
PrimaryPIEClientIndex int In multiplayer PIE which client will be the 'primary'. (default = 0, the first client) Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(ClampMin="-1", UIMin="-1", UIMax="64", ToolTip="In multiplayer PIE which client will be the 'primary'. Considered most important and given a larger client window, access to unique hardware like a VirtualReality HMD, etc. Intended to help test issues that affect the second, etc client. 0 is the first client. If the setting is >= than the number of clients the last will be primary. -1 will result in no primary. Note that this is an index only of PIE instance windows, in netmode 'Play as Client' pie instance zero is a windowless dedicated server, so setting 0 here would make the fist pie window the primary which would be PIEInstance 1, rather than 0 as in other netmodes.", DisplayName="Primary PIE Client Index")
RouteGamepadToSecondWindow bool When running multiple player windows in a single process, this option determines how the game pad input gets routed. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Client"
  • Meta=(EditCondition="RunUnderOneProcess")
RunUnderOneProcess bool Spawn multiple player windows in a single instance of UE. Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
ServerDebugDrawingColorTint FLinearColor Debug drawing originating from the server will be biased towards this color Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
ServerDebugDrawingColorTintStrength float How strongly debug drawing originating from the server will be biased towards the tint color Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options"
  • Meta=(ClampMin=0, ClampMax=1, UIMin=0, UIMax=1)
ServerMapNameOverride FString Override the map launched by the dedicated server (currently only used when in PIE_StandaloneWithServer net mode) Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Server"
  • Meta=(EditCondition="PlayNetMode != EPlayNetMode::PIE_Standalone || bLaunchSeparateServer")
ServerPort uint16 What port used by the server for simple networking Settings/LevelEditorPlaySettings.h
  • Config
  • EditAnywhere
  • Category="Multiplayer Options|Server"
  • Meta=(ClampMin="1", UIMin="1", ClampMax="65535", EditCondition="PlayNetMode != EPlayNetMode::PIE_Standalone || bLaunchSeparateServer")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FMargin CalculateCustomUnsafeZones ( TArray< FVector2D >& CustomSafeZoneStarts,
TArray< FVector2D >& CustomSafeZoneDimensions,
FString& DeviceType,
FVector2D PreviewSize
)

   Settings/LevelEditorPlaySettings.h  

FMargin FlipCustomUnsafeZones ( TArray< FVector2D >& CustomSafeZoneStarts,
TArray< FVector2D >& CustomSafeZoneDimensions,
FString& DeviceType,
FVector2D PreviewSize
)

   Settings/LevelEditorPlaySettings.h  

bool GetAdditionalServerGameOptions ( FString& OutAdditionalServerGameOptions
) const

   Settings/LevelEditorPlaySettings.h  

bool GetClientWindowSize ( FIntPoint& OutClientWindowSize
) const

   Settings/LevelEditorPlaySettings.h  

EVisibility GetClientWindowSizeVisibility()

   Settings/LevelEditorPlaySettings.h  

EBuildConfiguration GetLaunchBuildConfiguration()

   Settings/LevelEditorPlaySettings.h  

EVisibility GetNetworkEmulationVisibility()

   Settings/LevelEditorPlaySettings.h  

bool GetPlayNetMode ( EPlayNetMode& OutPlayNetMode
) const

   Settings/LevelEditorPlaySettings.h  

EVisibility GetPlayNetModeVisibility()

   Settings/LevelEditorPlaySettings.h  

bool GetPlayNumberOfClients ( int32& OutPlayNumberOfClients
) const

   Settings/LevelEditorPlaySettings.h  

int GetPrimaryPIEClientIndex()

   Settings/LevelEditorPlaySettings.h  

bool GetRouteGamepadToSecondWindow ( bool& OutRouteGamepadToSecondWindow
) const

   Settings/LevelEditorPlaySettings.h  

EVisibility GetRouteGamepadToSecondWindowVisibility()

   Settings/LevelEditorPlaySettings.h  

bool GetRunUnderOneProcess ( bool& OutRunUnderOneProcess
) const

   Settings/LevelEditorPlaySettings.h  

bool GetServerMapNameOverride ( FString& OutStandaloneServerMapName
) const

   Settings/LevelEditorPlaySettings.h  

EVisibility GetServerMapNameOverrideVisibility()

   Settings/LevelEditorPlaySettings.h  

bool GetServerPort ( uint16& OutServerPort
) const

   Settings/LevelEditorPlaySettings.h  

bool IsAdditionalServerGameOptionsActive()

   Settings/LevelEditorPlaySettings.h  

bool IsClientWindowSizeActive()

   Settings/LevelEditorPlaySettings.h  

bool IsCreateAudioDeviceForEveryPlayer()

   Settings/LevelEditorPlaySettings.h  

bool IsHMDForPrimaryProcessOnly()

   Settings/LevelEditorPlaySettings.h  

bool IsNetworkEmulationEnabled()

 Should network emulation settings be applied or not Settings/LevelEditorPlaySettings.h  

bool IsOneHeadsetEachProcess()

   Settings/LevelEditorPlaySettings.h  

bool IsPlayNetModeActive()

   Settings/LevelEditorPlaySettings.h  

bool IsPlayNumberOfClientsActive()

   Settings/LevelEditorPlaySettings.h  

bool IsRouteGamepadToSecondWindowActive()

   Settings/LevelEditorPlaySettings.h  

bool IsRunUnderOneProcessActive()

   Settings/LevelEditorPlaySettings.h  

bool IsServerMapNameOverrideActive()

   Settings/LevelEditorPlaySettings.h  

bool IsServerPortActive()

   Settings/LevelEditorPlaySettings.h  

void RegisterCommonResolutionsMenu()

 Creates a widget for the resolution picker. Settings/LevelEditorPlaySettings.h  

void RescaleForMobilePreview ( const UDeviceProfile* DeviceProfile,
int32& PreviewWidth,
int32& PreviewHeight,
float& ScaleFactor
)

   Settings/LevelEditorPlaySettings.h  

void SetClientWindowSize ( const FIntPoint InClientWindowSize
)

   Settings/LevelEditorPlaySettings.h  

void SetPlayNetMode ( const EPlayNetMode InPlayNetMode
)

 Accessors for fetching the values of multiplayer options, and returning whether the option is valid at this time. Settings/LevelEditorPlaySettings.h  

void SetPlayNumberOfClients ( const int32 InPlayNumberOfClients
)

   Settings/LevelEditorPlaySettings.h  

void SetRunUnderOneProcess ( const bool InRunUnderOneProcess
)

   Settings/LevelEditorPlaySettings.h  

void SetServerPort ( const uint16 InServerPort
)

   Settings/LevelEditorPlaySettings.h  

bool ShowServerDebugDrawingByDefault()

   Settings/LevelEditorPlaySettings.h  

void UpdateCustomSafeZones()

 Recalculates and broadcasts safe zone size changes based on device to emulate and r.DebugSafeZone.TitleRatio values. Settings/LevelEditorPlaySettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Settings/LevelEditorPlaySettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Settings/LevelEditorPlaySettings.h  

virtual void PostInitProperties()

   Settings/LevelEditorPlaySettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddScreenResolutionSection ( UToolMenu* InToolMenu,
const TArray< FPlayScreenResolution >* Resolutions,
const FString SectionName
)

 Adds a section to the screen resolution menu. Settings/LevelEditorPlaySettings.h  

static FName GetCommonResolutionsMenuName()

   Settings/LevelEditorPlaySettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page