FRequestPlaySessionParams

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/PlayInEditorDataTypes.h

Include

#include "PlayInEditorDataTypes.h"

Syntax

struct FRequestPlaySessionParams

Variables

Name Description

Public variable

TOptional < FStr ...

 

AdditionalStandaloneCommandLineParameters

If specified, this will be appended to the parameters being passed to the stand executable.

Public variable

TWeakPtr < SWind ...

 

CustomPIEWindow

If specified, the PIE instance will be created inside this user-provided window instead of creating a default.

Public variable

TOptional < TWea ...

 

DestinationSlateViewport

If specified, the Play Session will be created inside of this Slate Viewport.

Public variable

ULevelEditorPla ...

 

EditorPlaySettings

A ULevelEditorPlaySettings instance that the session should be started with.

Public variable

TSubclassOf < AG ...

 

GameModeOverride

Public variable

FString

 

GlobalMapOverride

Override which map is loaded for the Play session.

Public variable

TOptional < FLau ...

 

LauncherTargetDevice

If specified, the play session will attempt to launch on a remote device and not in the local editor.

Public variable

TOptional < FStr ...

 

MobilePreviewTargetDevice

If set, this device name will be passed to the -MobileTargetDevice command line option.

Public variable

EPlaySessionDes ...

 

SessionDestination

Where should the session be launched? May be local or remote.

Public variable

TOptional < EPla ...

 

SessionPreviewTypeOverride

If set, preview an emulated version of some rendering specifications.

Public variable

TOptional < FVec ...

 

StartLocation

If this is set the Play session will start from this location instead of using the GameMode to find a Player Spawn.

Public variable

TOptional < FRot ...

 

StartRotation

If StartLocation is set, this can be used to optionally override the default (FRotator::ZeroRotator) rotation.

Public variable

EPlaySessionWor ...

 

WorldType

Is this PIE or SIE

Constructors

Name Description

Public function

FRequestPlaySessionParams()

Default Constructor.

Functions

Name Description

Public function Const

bool

 

HasPlayWorldPlacement()

Classes

Name

Description

Public struct

FLauncherDeviceInfo

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback