Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FEditorAnalyticsSession

Windows

MacOS

Linux

References

Module	EditorAnalyticsSession
Header	/Engine/Source/Developer/EditorAnalyticsSession/Public/EditorAnalyticsSession.h
Include	#include "EditorAnalyticsSession.h"

Syntax

struct FEditorAnalyticsSession

Variables

		Name	Description
	FString	AppId
	FString	AppVersion
	float	AverageFPS
	bool: 1	bCrashed
	bool: 1	bGPUCrashed
	bool: 1	bIs64BitOS
	bool: 1	bIsDebugger
	bool: 1	bIsInEnterprise
	bool: 1	bIsInPIE
	bool: 1	bIsInVRMode
	bool: 1	bIsLowDriveSpace
	bool: 1	bIsTerminating
	bool: 1	bIsVanilla
	bool: 1	bWasEverDebugger
	bool: 1	bWasShutdown
	FString	CPUBrand
	int32	CPULogicalCores
	int32	CPUPhysicalCores
	FString	CPUVendor
	FString	CurrentUserActivity
	FString	DesktopGPUAdapter
	FString	EngineVersion
	TOptional< int3...	ExitCode
	uint32	GPUDeviceID
	uint32	GPUVendorID
	FString	GRHIAdapterInternalDriverVersion
	FString	GRHIAdapterUserDriverVersion
	uint32	GRHIDeviceRevision
	int32	Idle1Min
	int32	Idle30Min
	int32	Idle5Min
	int32	IdleSeconds
	TOptional< int3...	MonitorExceptCode
	uint32	MonitorProcessID
	FString	OSMajor
	FString	OSMinor
	FString	OSVersion
	uint32	PlatformProcessID
	TArray< FString...	Plugins
	FString	ProjectDescription
	FString	ProjectID
	FString	ProjectName
	FString	ProjectVersion
	FString	RenderingGPUAdapter
	FString	SessionId
	FDateTime	StartupTimestamp
	FDateTime	Timestamp
	int32	TotalEditorInactivitySeconds
	uint64	TotalPhysicalRAM
	int32	TotalUserInactivitySeconds
	FString	UserId

Constructors

	Name	Description
	FEditorAnalyticsSession()

Functions

	Name	Description
bool	Delete()	Delete the stored values of this session. Does not modify the actual session object.
bool	FindSession ( const uint32 InSessionProcessId, FEditorAnalyticsSession& OutSessio... )	Find the sessions for which the PlatformProcessID matches the specified session process id.
bool	GetStoredSessionIDs ( TArray< FString >& OutSessions )	Retrieve a list of session IDs that are currently stored locally.
bool	IsLocked()	Is the local storage already locked?
bool	Load ( const FString& InSessionID )	Load a session with the given session ID from stored values.
bool	LoadAllStoredSessions ( TArray< FEditorAnalyticsSession >&... )	Read all stored sessions into the given array.
bool	Lock ( FTimespan Timeout )	Acquire a lock for local storage.
void	LogEvent ( EEventType EventTpe, const FDateTime& Timestamp )	Append an event to the session log.
bool	Save()	Save this session to stored values.
void	SaveExitCode ( int32 ExitCode )	Persist the Editor exit code corresponding of this session in the key-store value.
void	SaveMonitorExceptCode ( int32 ExceptCode )	Set the exception code that caused the monitor application to crash.
bool	SaveStoredSessionIDs ( const TArray< FString >& InSession... )	Save the given session IDs to storage.
bool	TryLock()	Try to acquire the local storage lock without blocking.
void	Unlock()	Unlock the local storage.

Enums

	Name	Description
	EEventType

Constants

Name	Description
StoredValuesLock

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

Take our survey

Dismiss