Navigation
API > API/Runtime > API/Runtime/SessionServices
Interface for game instances.
| Name | ISessionInstanceInfo |
| Type | class |
| Header File | /Engine/Source/Runtime/SessionServices/Public/ISessionInstanceInfo.h |
| Include Path | #include "ISessionInstanceInfo.h" |
Syntax
class ISessionInstanceInfo
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISessionInstanceInfo() |
Virtual destructor. | ISessionInstanceInfo.h |
Classes
| Name | Remarks |
|---|---|
| FLogReceivedEvent | Gets an event delegate that is executed when a new log message has been received. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteCommand
(
const FString& CommandString |
Executes a console command on this engine instance. | ISessionInstanceInfo.h | |
const FString & GetBuildDate() |
Gets instance's build date. | ISessionInstanceInfo.h | |
const FString & GetCurrentLevel() |
Gets the name of the level that the instance is currently running. | ISessionInstanceInfo.h | |
const FString & GetDeviceName() |
Gets the name of the device that this instance is running on. | ISessionInstanceInfo.h | |
int32 GetEngineVersion() |
Gets the instance's engine version number. | ISessionInstanceInfo.h | |
const FGuid & GetInstanceId() |
Gets the instance identifier. | ISessionInstanceInfo.h | |
const FString & GetInstanceName() |
Gets the name of this instance. | ISessionInstanceInfo.h | |
const FString & GetInstanceType() |
Gets the instance type (i.e. Editor or Game). | ISessionInstanceInfo.h | |
const FDateTime & GetLastUpdateTime() |
Gets the time at which the last update was received from this instance. | ISessionInstanceInfo.h | |
const TArray< TSharedPtr< FSessionLogMessage > > & GetLog() |
Gets the collection of log entries received from this instance. | ISessionInstanceInfo.h | |
TSharedPtr< ISessionInfo > GetOwnerSession() |
Gets a reference to the session that owns this instance. | ISessionInstanceInfo.h | |
const FString & GetPlatformName() |
Gets the name of the platform that the instance is running on. | ISessionInstanceInfo.h | |
float GetWorldTimeSeconds() |
Gets the instance's current game world time. | ISessionInstanceInfo.h | |
bool IsAuthorized() |
Check whether the current user is authorized to interact with this instance. | ISessionInstanceInfo.h | |
FLogReceivedEvent & OnLogReceived() |
ISessionInstanceInfo.h | ||
bool PlayHasBegun() |
Checks whether this instance has already begun game play. | ISessionInstanceInfo.h | |
void Terminate() |
Terminates the instance. | ISessionInstanceInfo.h |