ISessionInstanceInfo

Interface for game instances.

Windows
MacOS
Linux

References

Module

SessionServices

Header

/Engine/Source/Runtime/SessionServices/Public/ISessionInstanceInfo.h

Include

#include "ISessionInstanceInfo.h"

Syntax

class ISessionInstanceInfo

Remarks

Interface for game instances.

Destructors

Name Description

Public function Virtual

~ISessionInstanceInfo()

Virtual destructor.

Functions

Name Description

Public function

void

 

ExecuteCommand

(
    const FString& CommandString
)

Executes a console command on this engine instance.

Public function Const

const FStrin...

 

GetBuildDate()

Gets instance's build date.

Public function Const

const FStrin...

 

GetCurrentLevel()

Gets the name of the level that the instance is currently running.

Public function Const

const FStrin...

 

GetDeviceName()

Gets the name of the device that this instance is running on.

Public function Const

int32

 

GetEngineVersion()

Gets the instance's engine version number.

Public function Const

const FGuid ...

 

GetInstanceId()

Gets the instance identifier.

Public function Const

const FStrin...

 

GetInstanceName()

Gets the name of this instance.

Public function Const

const FStrin...

 

GetInstanceType()

Gets the instance type (i.e. Editor or Game).

Public function Const

const FDateT...

 

GetLastUpdateTime()

Gets the time at which the last update was received from this instance.

Public function

const TArray...

 

GetLog()

Gets the collection of log entries received from this instance.

Public function

TSharedPtr< ...

 

GetOwnerSession()

Gets a reference to the session that owns this instance.

Public function Const

const FStrin...

 

GetPlatformName()

Gets the name of the platform that the instance is running on.

Public function Const

float

 

GetWorldTimeSeconds()

Gets the instance's current game world time.

Public function Const

bool

 

IsAuthorized()

Check whether the current user is authorized to interact with this instance.

Public function

FLogReceived...

 

OnLogReceived()

Public function Const

bool

 

PlayHasBegun()

Checks whether this instance has already begun game play.

Public function

void

 

Terminate()

Terminates the instance.

Classes

Name

Description

Public class

FLogReceivedEvent

Gets an event delegate that is executed when a new log message has been received.

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