Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > Settings > ULevelEditorPlaySettings

Light Theme

Dark Theme

ULevelEditorPlaySettings

Implements the Editor's play settings.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULevelEditorPlaySettings

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Classes/Settings/LevelEditorPlaySettings.h
Include	#include "Settings/LevelEditorPlaySettings.h"

Syntax

class ULevelEditorPlaySettings : public UObject

Remarks

Implements the Editor's play settings.

Variables

	Name	Description
FString	AdditionalLaunchParameters	Extra parameters to be include as part of the command line for the standalone game.
FString	AdditionalLaunchParametersForMobile	Extra parameters to be included as part of the command line for a mobile-on-PC standalone game.
FString	AdditionalServerLaunchParameters	Additional options that will be passed to the server as arguments, for example -debug.
bool	AutoRecompileBlueprints	Whether to automatically recompile blueprints on PIE
bool	bAutoCompileBlueprintsOnLaunch	Whether to automatically recompile dirty Blueprints before launching
bool	bLaunchSeparateServer	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).
uint32: 1	bOnlyLoadVisibleLevelsInPIE	True if Play In Editor should only load currently-visible levels in PIE.
uint32: 1	bPreferToStreamLevelsInPIE
TEnumAsByte< EP...	BuildGameBeforeLaunch	Whether to build the game before launching on device.
uint32: 1	CenterNewWindow	Whether the new window should be centered on the screen.
TArray< FVector...	CustomUnsafeZoneDimensions
TArray< FVector...	CustomUnsafeZoneStarts
FString	DeviceToEmulate
uint32: 1	DisableStandaloneSound	Whether sound should be disabled when playing standalone games.
bool	EnableGameSound	Whether to play sounds during PIE
bool	EnablePIEEnterAndExitSounds	Whether to play a sound when entering and exiting PIE
bool	GameGetsMouseControl	Should Play-in-Editor automatically give mouse control to the game on PIE start (default = false).
TArray< FPlaySc...	LaptopScreenResolutions	Collection of common screen resolutions on mobile phones.
FString	LastExecutedLaunchDevice	The name of the last platform that the user ran a play session on.
TEnumAsByte< EL...	LastExecutedLaunchModeType	The last type of play-on session the user ran.
FString	LastExecutedLaunchName	The name of the last device that the user ran a play session on.
FString	LastExecutedPIEPreviewDevice	The name of the last device that the user ran a play session on.
TEnumAsByte< EP...	LastExecutedPlayModeLocation	The last type of play location the user ran.
TEnumAsByte< EP...	LastExecutedPlayModeType	The last type of play session the user ran.
TEnumAsByte< EP...	LaunchConfiguration	Which build configuration to use when launching on device.
TArray< FPlaySc...	MonitorScreenResolutions	Collection of common screen resolutions on desktop monitors.
TEnumAsByte< EL...	MouseControlLabelPosition	Location on screen to anchor the mouse control label when in PIE mode.
int32	MultipleInstanceLastHeight	The last used height for multiple instance windows (in pixels).
int32	MultipleInstanceLastWidth	The last used width for multiple instance windows (in pixels).
TArray< FIntPoi...	MultipleInstancePositions	The last known screen positions of multiple instance windows (in pixels).
FLevelEditorPla...	NetworkEmulationSettings	Customizable settings allowing to emulate latency and packetloss for game network transmissions
int32	NewWindowHeight	The height of the new view port window in pixels (0 = use the desktop's screen resolution).
FIntPoint	NewWindowPosition	The position of the new view port window on the screen in pixels.
int32	NewWindowWidth	The width of the new view port window in pixels (0 = use the desktop's screen resolution).
TArray< FPlaySc...	PhoneScreenResolutions	Collection of common screen resolutions on mobile phones.
uint32: 1	PIEAlwaysOnTop	Whether to always have the PIE window on top of the parent windows.
FMargin	PIESafeZoneOverride
FString	PlayFromHerePlayerStartClassName	The PlayerStart class used when spawning the player at the current camera location.
int32	PlayInEditorSoundQualityLevel	Which quality level to use when playing in editor
bool	ShouldMinimizeEditorOnVRPIE	Should we minimize the editor when VR PIE is clicked (default = true)
bool	ShowMouseControlLabel	Whether to show a label for mouse control gestures in the PIE view.
TArray< FPlaySc...	TabletScreenResolutions	Collection of common screen resolutions on tablet devices.
TArray< FPlaySc...	TelevisionScreenResolutions	Collection of common screen resolutions on television screens.
bool	UseMouseForTouch	While using the game viewport, it sends mouse movement and clicks as touch events, instead of as mouse events.
bool	ViewportGetsHMDControl	Should Play-in-Viewport respect HMD orientations (default = false)

Constructors

	Name	Description
	ULevelEditorPlaySettings ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
FMargin	CalculateCustomUnsafeZones ( TArray< FVector2D >& CustomSafeZon..., TArray< FVector2D >& CustomSafeZon..., FString& DeviceType, FVector2D PreviewSize )
FMargin	FlipCustomUnsafeZones ( TArray< FVector2D >& CustomSafeZon..., TArray< FVector2D >& CustomSafeZon..., FString& DeviceType, FVector2D PreviewSize )
bool	GetAdditionalServerGameOptions ( FString& OutAdditionalServerGameOp... )
bool	GetClientWindowSize ( FIntPoint& OutClientWindowSize )
EVisibility	GetClientWindowSizeVisibility()
EBuildConfig...	GetLaunchBuildConfiguration()
EVisibility	GetNetworkEmulationVisibility()
bool	GetPlayNetMode ( EPlayNetMode& OutPlayNetMode )
EVisibility	GetPlayNetModeVisibility()
bool	GetPlayNumberOfClients ( int32& OutPlayNumberOfClients )
bool	GetRouteGamepadToSecondWindow ( bool& OutRouteGamepadToSecondWindo... )
EVisibility	GetRouteGamepadToSecondWindowVisibility()
bool	GetRunUnderOneProcess ( bool& OutRunUnderOneProcess )
bool	GetServerMapNameOverride ( FString& OutStandaloneServerMapNam... )
EVisibility	GetServerMapNameOverrideVisibility()
bool	GetServerPort ( uint16& OutServerPort )
bool	IsAdditionalServerGameOptionsActive()
bool	IsClientWindowSizeActive()
bool	IsCreateAudioDeviceForEveryPlayer()
bool	IsNetworkEmulationEnabled()	Should network emulation settings be applied or not
bool	IsPlayNetModeActive()
bool	IsPlayNumberOfClientsActive()
bool	IsRouteGamepadToSecondWindowActive()
bool	IsRunUnderOneProcessActive()
bool	IsServerMapNameOverrideActive()
bool	IsServerPortActive()
void	RescaleForMobilePreview ( const UDeviceProfile* DevicePr..., int32& PreviewWidth, int32& PreviewHeight, float& ScaleFactor )
void	SetClientWindowSize ( const FIntPoint InClientWindowSize )
void	SetPlayNetMode ( const EPlayNetMode InPlayNetMode )	Accessors for fetching the values of multiplayer options, and returning whether the option is valid at this time.
void	SetPlayNumberOfClients ( const int32 InPlayNumberOfClients )
void	SetRunUnderOneProcess ( const bool InRunUnderOneProcess )
void	SetServerPort ( const uint16 InServerPort )
void	UpdateCustomSafeZones()	Recalculates and broadcasts safe zone size changes based on device to emulate and r.DebugSafeZone.TitleRatio values.

Overridden from UObject

	Name	Description
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Deprecated Variables

		Name	Description
	TWeakPtr< SWind...	CustomPIEWindow	This variable is no longer read. Specify the Custom Window in the FRequestPlaySessionParams instead during PIE request.

Deprecated Functions

	Name	Description
bool	GetAdditionalLaunchOptions ( FString& OutAdditionalLaunchOption... )	Read AdditionalServerLaunchParmeters directly instead.
EVisibility	GetAdditionalLaunchOptionsVisibility()	Read AdditionalServerLaunchParmeters for a non-zero length instead.
bool	GetAutoConnectToServer ( bool& OutAutoConnectToServer )	This feature has been removed. Set PlayNetMode == EPlayNetMode::PIE_Standalone instead.
EVisibility	GetAutoConnectToServerVisibility()	This feature has been removed. Set PlayNetMode == EPlayNetMode::PIE_Standalone instead.
bool	GetPlayNetDedicated ( bool& OutPlayNetDedicated )	Read bLaunchSeparateServer directly instead.
bool	IsAdditionalLaunchOptionsActive()	Read AdditionalServerLaunchParmeters for a non-zero length instead.
bool	IsAutoConnectToServerActive()	This feature has been removed. Set PlayNetMode == EPlayNetMode::PIE_Standalone instead.
bool	IsPlayNetDedicatedActive()	Read bLaunchSeparateServer directly instead.
void	SetPlayNetDedicated ( const bool InPlayNetDedicated )	Read bLaunchSeparateServer directly instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss