ISessionInstanceInfo Class Reference

#include <ISessionInstanceInfo.h>

Inheritance diagram for ISessionInstanceInfo:

Public Member Functions
virtual void	ExecuteCommand (const FString &CommandString)=0
virtual const FString &	GetBuildDate () const =0
virtual const FString &	GetCurrentLevel () const =0
virtual const FString &	GetDeviceName () const =0
virtual int32	GetEngineVersion () const =0
virtual const FGuid &	GetInstanceId () const =0
virtual const FString &	GetInstanceName () const =0
virtual const FString &	GetInstanceType () const =0
virtual const FDateTime &	GetLastUpdateTime () const =0
virtual const TArray< TSharedPtr< FSessionLogMessage > > &	GetLog ()=0
virtual TSharedPtr< ISessionInfo >	GetOwnerSession ()=0
virtual const FString &	GetPlatformName () const =0
virtual float	GetWorldTimeSeconds () const =0
virtual bool	IsAuthorized () const =0
virtual bool	PlayHasBegun () const =0
virtual void	Terminate ()=0
	DECLARE_EVENT_TwoParams (ISessionInstanceInfo, FLogReceivedEvent, const TSharedRef< ISessionInstanceInfo > &, const TSharedRef< FSessionLogMessage > &)
virtual FLogReceivedEvent &	OnLogReceived ()=0
virtual	~ISessionInstanceInfo ()

Detailed Description

Interface for game instances.

Constructor & Destructor Documentation

~ISessionInstanceInfo()

virtual ISessionInstanceInfo::~ISessionInstanceInfo ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

DECLARE_EVENT_TwoParams()

ISessionInstanceInfo::DECLARE_EVENT_TwoParams	(	ISessionInstanceInfo	,
		FLogReceivedEvent	,
		const TSharedRef< ISessionInstanceInfo > &	,
		const TSharedRef< FSessionLogMessage > &
	)

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

Returns

The delegate.

ExecuteCommand()

virtual void ISessionInstanceInfo::ExecuteCommand ( const FString &  CommandString )

pure virtual

Executes a console command on this engine instance.

Parameters

CommandString

The command to execute.

Implemented in FSessionInstanceInfo.

GetBuildDate()

virtual const FString & ISessionInstanceInfo::GetBuildDate ( ) const

pure virtual

Gets instance's build date.

Returns

The build date string.

Implemented in FSessionInstanceInfo.

GetCurrentLevel()

virtual const FString & ISessionInstanceInfo::GetCurrentLevel ( ) const

pure virtual

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

Returns

The name of the level.

Implemented in FSessionInstanceInfo.

GetDeviceName()

virtual const FString & ISessionInstanceInfo::GetDeviceName ( ) const

pure virtual

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

Returns

The device name string.

Implemented in FSessionInstanceInfo.

GetEngineVersion()

virtual int32 ISessionInstanceInfo::GetEngineVersion ( ) const

pure virtual

Gets the instance's engine version number.

Returns

Engine version.

Implemented in FSessionInstanceInfo.

GetInstanceId()

virtual const FGuid & ISessionInstanceInfo::GetInstanceId ( ) const

pure virtual

Gets the instance identifier.

Returns

Instance identifier.

Implemented in FSessionInstanceInfo.

GetInstanceName()

virtual const FString & ISessionInstanceInfo::GetInstanceName ( ) const

pure virtual

Gets the name of this instance.

Returns

The instance name string.

Implemented in FSessionInstanceInfo.

GetInstanceType()

virtual const FString & ISessionInstanceInfo::GetInstanceType ( ) const

pure virtual

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

Returns

The game instance type string.

Implemented in FSessionInstanceInfo.

GetLastUpdateTime()

virtual const FDateTime & ISessionInstanceInfo::GetLastUpdateTime ( ) const

pure virtual

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

Returns

The receive time.

Implemented in FSessionInstanceInfo.

GetLog()

virtual const TArray< TSharedPtr< FSessionLogMessage > > & ISessionInstanceInfo::GetLog ( )

pure virtual

Gets the collection of log entries received from this instance.

Returns

Log entries.

Implemented in FSessionInstanceInfo.

GetOwnerSession()

virtual TSharedPtr< ISessionInfo > ISessionInstanceInfo::GetOwnerSession ( )

pure virtual

Gets a reference to the session that owns this instance.

Returns

Owner session.

Implemented in FSessionInstanceInfo.

GetPlatformName()

virtual const FString & ISessionInstanceInfo::GetPlatformName ( ) const

pure virtual

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

Returns

Platform name string.

Implemented in FSessionInstanceInfo.

GetWorldTimeSeconds()

virtual float ISessionInstanceInfo::GetWorldTimeSeconds ( ) const

pure virtual

Gets the instance's current game world time.

Returns

World time in seconds.

Implemented in FSessionInstanceInfo.

IsAuthorized()

virtual bool ISessionInstanceInfo::IsAuthorized ( ) const

pure virtual

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

Returns

true if the user is authorized, false otherwise.

Implemented in FSessionInstanceInfo.

OnLogReceived()

virtual FLogReceivedEvent & ISessionInstanceInfo::OnLogReceived ( )

pure virtual

Implemented in FSessionInstanceInfo.

PlayHasBegun()

virtual bool ISessionInstanceInfo::PlayHasBegun ( ) const

pure virtual

Checks whether this instance has already begun game play.

Returns

true if game play has begun, false otherwise.

Implemented in FSessionInstanceInfo.

Terminate()

virtual void ISessionInstanceInfo::Terminate ( )

pure virtual

Terminates the instance.

Implemented in FSessionInstanceInfo.

---

The documentation for this class was generated from the following file:

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