1. Epic GamesDeveloper
  3. ULevelEditorPlaySettings

ULevelEditorPlaySettings

Implements the Editor's play settings.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Settings

Inheritance Hierarchy

References

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

Syntax

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

Remarks

Implements the Editor's play settings.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere Config FString AdditionalLaunchParameters Extra parameters to be include as part of the command line for the standalone game.
Public variable UProperty Category, EditAnywhere Config FString AdditionalServerLaunchParameters Additional options that will be passed to the server as arguments, for example -debug.
Public variable UProperty Category, EditAnywhere, Meta Config bool AutoRecompileBlueprints Whether to automatically recompile blueprints on PIE
Public variable UProperty Category, EditAnywhere Config bool bAutoCompileBlueprintsOnLaunch Whether to automatically recompile dirty Blueprints before launching
Public variable UProperty Category, EditAnywhere Config bool bEmulateStereo Whether we should emulate stereo (helps checking VR rendering issues).
Public variable UProperty Category, EditAnywhere Config 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).
Public variable UProperty Config uint32: 1 bOnlyLoadVisibleLevelsInPIE True if Play In Editor should only load currently-visible levels in PIE.
Public variable UProperty Category, EditAnywhere, Meta Config uint32: 1 bPreferToStreamLevelsInPIE  
Public variable UProperty Category, EditAnywhere Config bool bPromoteOutputLogWarningsDuringPIE Should warnings and errors in the Output Log during "Play in Editor" be promoted to the message log?
Public variable UProperty Category, EditAnywhere, Meta Config bool bShouldMinimizeEditorOnNonVRPIE Should we minimize the editor when non-VR PIE is clicked (default = false)
Public variable UProperty Category, EditAnywhere Config TEnumAsByte< EPlayOnBuildMode > BuildGameBeforeLaunch Whether to build the game before launching on device.
Public variable UProperty Config bool bUseNonRealtimeAudioDevice Whether to use a non-realtime audio device during PIE
Public variable UProperty Category, EditAnywhere Config uint32: 1 CenterNewWindow Whether the new window should be centered on the screen.
Public variable UProperty Category, EditAnywhere, Meta Config TArray< int32 > ClientFixedFPS If > 0, Tick clients at a fixed frame rate.
Public variable UProperty Config TArray< FVector2D > CustomUnsafeZoneDimensions  
Public variable UProperty Config TArray< FVector2D > CustomUnsafeZoneStarts  
Public variable UProperty Category Config visibleanywhere FString DeviceToEmulate  
Public variable UProperty Category, EditAnywhere Config uint32: 1 DisableStandaloneSound Whether sound should be disabled when playing standalone games.
Public variable UProperty Category, EditAnywhere, Meta Config bool EnableGameSound Whether to play sounds during PIE
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config bool EnablePIEEnterAndExitSounds Whether to play a sound when entering and exiting PIE
Public variable UProperty Category, EditAnywhere, Meta Config bool GameGetsMouseControl Should Play-in-Editor automatically give mouse control to the game on PIE start (default = false).
Public variable UProperty Config TArray< FPlayScreenResolution > LaptopScreenResolutions Collection of common screen resolutions on mobile phones.
Public variable UProperty Config FString LastExecutedLaunchDevice The name of the last platform that the user ran a play session on.
Public variable UProperty Config TEnumAsByte< ELaunchModeType > LastExecutedLaunchModeType The last type of play-on session the user ran.
Public variable UProperty Config FString LastExecutedLaunchName The name of the last device that the user ran a play session on.
Public variable UProperty Config FString LastExecutedPIEPreviewDevice The name of the last device that the user ran a play session on.
Public variable UProperty Config TEnumAsByte< EPlayModeLocations > LastExecutedPlayModeLocation The last type of play location the user ran.
Public variable UProperty Config TEnumAsByte< EPlayModeType > LastExecutedPlayModeType The last type of play session the user ran.
Public variable UProperty Config FIntPoint LastSize The last known screen size for the first instance window (in pixels).
Public variable UProperty Category, EditAnywhere Config TEnumAsByte< EPlayOnLaunchConfiguration > LaunchConfiguration Which build configuration to use when launching on device.
Public variable UProperty Config TArray< FPlayScreenResolution > MonitorScreenResolutions Collection of common screen resolutions on desktop monitors.
Public variable UProperty Category, EditAnywhere Config TEnumAsByte< ELabelAnchorMode > MouseControlLabelPosition Location on screen to anchor the mouse control label when in PIE mode.
Public variable UProperty Config TArray< FIntPoint > MultipleInstancePositions The last known screen positions of multiple instance windows (in pixels).
Public variable UProperty Category, EditAnywhere Config FLevelEditorPlayNetworkEmulationSettings NetworkEmulationSettings Customizable settings allowing to emulate latency and packetloss for game network transmissions
Public variable UProperty Category, EditAnywhere, Meta Config int32 NewWindowHeight The height of the new view port window in pixels (0 = use the desktop's screen resolution).
Public variable UProperty Category, EditAnywhere Config FIntPoint NewWindowPosition The position of the new view port window on the screen in pixels.
Public variable UProperty Category, EditAnywhere, Meta Config int32 NewWindowWidth The width of the new view port window in pixels (0 = use the desktop's screen resolution).
Public variable UProperty Category, EditAnywhere Config EPlayOnPakFileMode PackFilesForLaunch Whether to content should be stored in pak files when launching on device. */.
Public variable UProperty Config TArray< FPlayScreenResolution > PhoneScreenResolutions Collection of common screen resolutions on mobile phones.
Public variable UProperty Category, EditAnywhere, Meta Config uint32: 1 PIEAlwaysOnTop Whether to always have the PIE window on top of the parent windows.
Public variable UProperty Config FMargin PIESafeZoneOverride  
Public variable UProperty GlobalConfig FString PlayFromHerePlayerStartClassName The PlayerStart class used when spawning the player at the current camera location.
Public variable UProperty Category, EditAnywhere Config int32 PlayInEditorSoundQualityLevel Which quality level to use when playing in editor
Public variable UProperty Category, EditAnywhere, Meta Config int32 ServerFixedFPS If > 0, Tick dedicated server at a fixed frame rate.
Public variable UProperty Category, EditAnywhere, Meta Config bool ShouldMinimizeEditorOnVRPIE Should we minimize the editor when VR PIE is clicked (default = true)
Public variable UProperty Category, EditAnywhere Config bool ShowMouseControlLabel Whether to show a label for mouse control gestures in the PIE view.
Public variable UProperty Category, EditAnywhere, Meta Config bool SoloAudioInFirstPIEClient Whether to automatically solo audio in first PIE client.
Public variable UProperty Config TArray< FPlayScreenResolution > TabletScreenResolutions Collection of common screen resolutions on tablet devices.
Public variable UProperty Config TArray< FPlayScreenResolution > TelevisionScreenResolutions Collection of common screen resolutions on television screens.
Public variable UProperty Category, EditAnywhere Config bool UseMouseForTouch While using the game viewport, it sends mouse movement and clicks as touch events, instead of as mouse events.
Public variable UProperty Category, EditAnywhere, Meta Config bool ViewportGetsHMDControl Should Play-in-Viewport respect HMD orientations (default = false)

Constructors

  Type Name Description
Public function  

ULevelEditorPlaySettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Static void

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

 Adds a section to the screen resolution menu.
Public function FMargin

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

  
Public function FMargin

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

  
Public function Const bool

GetAdditionalServerGameOptions ( FString& OutAdditionalServerGameOptions
)

  
Public function Const bool

GetClientWindowSize ( FIntPoint& OutClientWindowSize
)

  
Public function Const EVisibility  
Public function Static FName  
Public function Const EBuildConfiguration  
Public function Const EVisibility  
Public function Const bool

GetPlayNetMode ( EPlayNetMode& OutPlayNetMode
)

  
Public function Const EVisibility  
Public function Const bool

GetPlayNumberOfClients ( int32& OutPlayNumberOfClients
)

  
Public function Const int  
Public function Const bool

GetRouteGamepadToSecondWindow ( bool& OutRouteGamepadToSecondWindow
)

  
Public function Const EVisibility  
Public function Const bool

GetRunUnderOneProcess ( bool& OutRunUnderOneProcess
)

  
Public function Const bool

GetServerMapNameOverride ( FString& OutStandaloneServerMapName
)

  
Public function Const EVisibility  
Public function Const bool

GetServerPort ( uint16& OutServerPort
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Should network emulation settings be applied or not
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void Creates a widget for the resolution picker.
Public function void

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

  
Public function void

SetClientWindowSize ( const FIntPoint InClientWindowSize
)

  
Public function void

SetPlayNetMode ( const EPlayNetMode InPlayNetMode
)

 Accessors for fetching the values of multiplayer options, and returning whether the option is valid at this time.
Public function void

SetPlayNumberOfClients ( const int32 InPlayNumberOfClients
)

  
Public function void

SetRunUnderOneProcess ( const bool InRunUnderOneProcess
)

  
Public function void

SetServerPort ( const uint16 InServerPort
)

  
Public function Const bool  
Public function void Recalculates and broadcasts safe zone size changes based on device to emulate and r.DebugSafeZone.TitleRatio values.

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page